How to Download & Install PlaneText

ダウンロード
PlaneText Ver.0.0.1 は こちら の GitHub プロジェクトページから入手することができます。プロジェクトページ右下の Download ZIP をクリックすることで一式をダウンロードするか、あるいは git clone コマンドを使って取得してください。

必須環境
コマンドライン版・GUI ツール版、いずれにおいても Ruby (2.0 以上, 1.9+では未検証・動作可能性あり) が動作する UNIX 環境が必要です。
GUI ツールを利用する場合は、Web ブラウザ (Chrome) が必要になります。また、GUI ツールを常駐させたい場合は Passenger 等の rack server が必要になります。

インストール
ZIP ファイルをダウンロードして解凍するか、git clone で取得することにより得られた planetext ディレクトリを適当な場所に置いてください。
planetext ディレクトリの直下で,

> bundle install --without development

を実行することで、必要なパッケージのインストールが開始されます。

コマンドライン版・GUI版 ともに PlaneText の実行にはコンフィグファイル config.yaml (この名前であることが必須です)が必要です。雛形は config.yaml.example にありますので、こちらをそのままコピーすることで使用できます。

> cp config.yaml.example config.yaml

コンフィグファイルのカスタマイズについては、入出力の仕様 および config.yaml.example 内の記述等をご参照ください。

以上の作業を済ませた後で、planetext ディレクトリの直下で

> ./bin/planetext --help

を実行し、コマンドライン版の PlaneText のヘルプが表示されれば、準備は完了です。
以降の操作に関しては、使い方 およびパッケージ内の README を参照ください。

Download
PlaneText Ver.0.0.1 can be downloaded from GitHub project page. Please download the whole package by clicking “Download ZIP” or using “git clone” command.

Requirement
A UNIX environment where Ruby 2.0+ (1.9 may be possible) is installed is required (both for command-line/GUI version). If you want to use GUI version, Web browser (Chrome) is also required. If you want to make GUI version resident, rack servers such as Passenger is required.

Install
Download & unpack ZIP file or “git clone” to obtain package directory and put the directory somewhere in your UNIX environment.
Under the package directory (here we name it “planetext” directory), execute

> bundle install --without development

then bundled packages are automatically installed.

In order to run command-line/GUI version of PlaneText, configure file named “config.yaml” is required. You can obtain the file just by copying/renaming a default file “config.yaml.example”:

> cp config.yaml.example config.yaml

On customization of the configure file, please refer to INPUT/OUTPUT or description in “config.yaml.example”.

After the above process, execute under “planetext” top directory

> ./bin/planetext --help

and confirm that help message for command-line version is shown.

Please refer to HOW TO USE on actual conversion.