Skip to content

Commit

Permalink
Add notes about setup script
Browse files Browse the repository at this point in the history
  • Loading branch information
asamuzaK committed Mar 30, 2017
1 parent 93e85c8 commit 4e02584
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 4 deletions.
41 changes: 39 additions & 2 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,47 @@ Githubのアカウントがある場合は、レポジトリをクローンし
* withExEditorHost v1.xでは、Node.js v6.9.5以上を必要とします。
* withExEditorHost v2.xでは、Node.js v7.6.0以上(現時点)を必要とします。

***

## ホストの設定

Windowsでは"cmd.exe"、Linux / Macでは「端末」(ターミナル)を開き、セットアップスクリプトを実行します。
なお、Windowsの環境によっては、管理者権限で"cmd.exe"を実行する必要があるかもしれません。

Windows:
```
> cd path\to\withExEditorHost
> node setup.js
```

Linux / Mac:
```
$ cd path/to/withexeditorhost
$ sudo node setup.js
```

セットアップスクリプトは、デフォルトでwithExEditorHostの保存先の直下に"config"フォルダを作成し各設定ファイルを保持します。
設定ファイルの保存先を変更したい場合は、`--config-path`引数で指定してください。

```
> node setup.js --config-path="C:\Users\XXX\path\to\another\location"
```

スクリプトを実行すると以下の入力を求められますので適宜入力してください。

* エディタのパス
* コマンドラインオプション
* 一時ファイルをコマンドラインオプションの後に置くか

その場では何も入力せず、後で設定することもできます。
詳しくは、下記「エディタ設定ファイルの編集」のセクションを参照してください。

設定ファイルが正常に作成されたら、Firefoxを再起動してください。

***

## 手動設定

withExEditorHostの"_config"というフォルダの中に必要な設定ファイルのサンプルがあります。

_configフォルダのコピーを作成して`config`にリネームしてください。
Expand Down Expand Up @@ -103,8 +142,6 @@ Mac:
例えば、defaultのプロファイルでは"editorconfig.json"を使い、nightlyのプロファイルでは"editorconfig-nightly.json"といった別名のエディタ設定ファイルを用意するなど。
なお、"editorconfig.json"以外の名前を使用する場合は、withExEditor本体の設定ページでエディタ設定ファイルのパスを入力してください。

***

以上の作業を終えたら、Firefoxを再起動してください。

***
Expand Down
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,47 @@ Also note that the host depends on the version of Node.js.
* withExEditorHost v1.x requires Node.js v6.9.5 or higher.
* withExEditorHost v2.x requires Node.js v7.6.0 (at this time) or higher.

***

## Setting up the host

Open "cmd.exe" on Windows, "terminal" on Linux / Mac, and run setup script.
Depending on the Windows environment, you may need to run "cmd.exe" as admin.

Windows:
```
> cd path\to\withExEditorHost
> node setup.js
```

Linux / Mac:
```
$ cd path/to/withexeditorhost
$ sudo node setup.js
```

By default, the setup script creates a "config" folder under the location of withExEditorHost.
If you want to save setting files in different location, use `--config-path` argument.

```
> node setup.js --config-path="C:\Users\XXX\path\to\another\location"
```

You will be prompted for the following, please input as appropriate.

* Enter editor path
* Enter command line options
* Put file path after command arguments?

You can leave them empty and set them later too.
For details, refer to the section "Edit the editor configuration" below.

If config files are created successfully, restart Firefox.

***

## Manual setup

There are sample configuration files in "_config" folder of withExEditorHost.

Create a copy of the _config folder and rename it to `config`.
Expand Down Expand Up @@ -102,8 +141,6 @@ Editor configuration files can also be switched for each Firefox profile.
For example, use "editorconfig.json" for the default profile, and prepare another configuration file such as "editorconfig-nightly.json" for nightly's profile.
When you choose a name other than "editorconfig.json", enter the path of the editor configuration file in the Options page of withExEditor.

***

After the above work, restart Firefox.

***
Expand Down

0 comments on commit 4e02584

Please sign in to comment.