neri 0.9.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3304d7a43e47d1c93dc43962118bf588a6c1f3b7a854d953f3e0d7121febdb
-  data.tar.gz: 7611ecaaff29fdf70b3b1e94693e5091096b8ba4fb3ca92ac3835935616bb72a
+  metadata.gz: 57f66e92c785a8a350a76ae6ac0ca0415da25389a5850033b25ca5635ec3d091
+  data.tar.gz: '08b3a7608a8b5197597940787da7afa75a421bcc5b87503cb309f375e56f8b73'
 SHA512:
-  metadata.gz: 89003370b9274c9ede6610723cdb8ec61b5452558b24f9328bad47e68d9b900831ccce480be775b739e01f6c6bd24f84e148ff88ef9d25c519199846f0640ee9
-  data.tar.gz: ac6d1ec8ee9c02ad027628dd1618757a4c257b1f2c9e2b5803e58414665622c172aaf36840cefce735731418b390a4bab25f6eb8598a002268686f1f27534a8e
+  metadata.gz: 3fba1fb3e64325fc9469eafcb66816937207d0577aba9a647099b95ad16f98dd138dc14fe5c6294fbfc84425eebaf5e1a6bb7d615d8351334b914c55de0576c8
+  data.tar.gz: 944a9f3570ea0ce11d34194f775e0217932200a3ff420ee7d72996a6aa3b706c210c0bbd0bad333099aa18740ae9193c3d26ca5c4dfa9732abcf64b038b1b3c6

data/README.ja.md

@@ -1,27 +1,25 @@
 # Neri
 
-Neri は、Ruby スクリプトを Ruby 未インストール環境向けに配布するためのパッケージングシステムです。
+Neri は、Ruby スクリプトを Ruby 未インストール環境の Windows 向けに配布するためのパッケージングシステムです。
 
 同種の gem としては [OCRA](https://github.com/larsch/ocra) がありますが、以下のような違いがあります。
 
 - OCRA に比べての長所
   - 展開しない分、起動が速い。
-  - 実行ファイルを複数作りたいとき、OCRA ではサイズの大きな実行ファイルを複数生成することになってしまうが、Neri ではシステムファイルを共有できるので、全体のサイズが大きくならずに済む。
-  - OCRA には「日本語を含むユーザー名の環境では起動できない」という問題があるが、Neri にはない。
-    - ただし Ruby のバージョンによっては、日本語を含むパス上では起動できない。（この点は OCRA も同様。）
+  - 実行ファイルを複数作りたいとき、OCRA ではサイズの大きな実行ファイルを複数生成することになってしまうが、Neri ではシステムファイルを共有できるため全体のサイズが大きくならずに済む。
 - OCRA に比べての短所
-  - exe ファイルを作成するには、次のどちらかが必要。
-    - gcc と windres（Ruby Installer 2 With Devkit を使用している場合、使用前に `ridk enable` を実行してパスを通す必要があるかもしれません。）
-    - [Bat To Exe Converter](http://www.f2ko.de/en/b2e.php) ver.3
+  - 基本的に、[Ruby Installer 2](https://rubyinstaller.org/) With Devkit で Ruby をインストールした環境でしか利用できない。（なお、使用前に `ridk enable` を実行してパスを通す必要があります。）
 
 ## インストール
 
     $ gem install neri
 
-現状、bundler での使用は保証できません。
+bundler を用いた利用もできますが、その場合同梱するファイルが増えてしまうのでおすすめしません。
 
 ## 使い方
 
+まず、`ridk enable` を実行して開発環境にパスを通す必要があります。
+
     $ neri [options] script.rb (other_files...) -- script_arguments
 
 上の例では、一度 "script.rb" を依存ファイルチェックのために実行し、
@@ -41,16 +39,18 @@ Neri は、Ruby スクリプトを Ruby 未インストール環境向けに配
   <dd>バージョンを表示します。</dd>
   <dt>--quiet</dt>
   <dd>実行中に途中経過等を表示しなくなります。</dd>
-  <dt>--verbose</dt>
-  <dd>実行中に詳細情報を表示するようになります。</dd>
+  <dt>--external-encoding</dt>
+  <dd>出力の文字コードを設定します。後述する --pause-text 等の設定で文字化けが生じる場合、sjis 等を設定してください。</dd>
 </dl>
 
 #### 依存ファイルの追加
 
 Neri は実行時に必要と思われるファイルを自動的に依存ファイルとして出力先にコピーしますが、
-実行に必要なファイルが足りない場合もあります。
+その判定がうまくいかず実行に必要なファイルが足りない場合もあります。
 そうした場合はこれらのオプションで依存ファイルを手動で追加する必要があります。
 
+（もしくは、直接出力先に手動で必要なファイルをコピーするのも1つの方法です。）
+
 <dl>
   <dt>--dll &lt;dll1&gt;,&lt;dll2&gt;,...</dt>
   <dd>bin フォルダ内の指定された dll ファイルを依存ファイルに追加します。</dd>
@@ -58,7 +58,7 @@ Neri は実行時に必要と思われるファイルを自動的に依存ファ
   <dd>ロードパス（$LOAD_PATH）内の指定されたファイルを依存ファイルに追加します。</dd>
   <dt>--gem &lt;gem1&gt;,&lt;gem2&gt;,...</dt>
   <dd>指定された gem のファイルを依存ファイルに追加します。
-  デフォルトでは、該当 gem の lib フォルダ内のファイル一式を依存ファイルに追加します。
+  デフォルトでは、該当 gem の lib フォルダ内のファイル一式を依存ファイルに追加します。（たとえば `--gem gemname:dir1|dir2` とすれば、lib フォルダ以外のファイルを追加できます。）
   現状、gem 間の依存等はチェックしないので、必要な gem すべてを手動で追加する必要があります。</dd>
 </dl>
 
@@ -83,11 +83,13 @@ Neri はデフォルトでは、enc フォルダ内の文字コードライブ
 
 <dl>
   <dt>--enable-gems</dt>
-  <dd>rubygems を使用します。このオプションを使わない場合、依存チェック時に使用した gem のファイルは vendor_ruby フォルダ内にコピーされ、rubygems 無しでも実行できるようになります。</dd>
+  <dt>--disable-gems (デフォルト)</dt>
+  <dd>rubygems を使用するかどうかを設定します。--disable-gems の場合も、依存チェック時に使用した gem のファイルは vendor_ruby フォルダ内にコピーされるため、rubygems 無しでも実行できるようになります。</dd>
   <dt>--enable-did-you-mean</dt>
-  <dd>did_you_mean を使用します。</dd>
-  <dt>--chdir-first</dt>
-  <dd>実行時に、カレントフォルダを実行ファイルと同じフォルダに設定します。</dd>
+  <dt>--disable-did-you-mean (デフォルト)</dt>
+  <dd>did_you_mean を使用するかどうかを設定します。</dd>
+  <dt>--no-chdir</dt>
+  <dd>Neri で作成した実行ファイルは、デフォルトでは実行時にカレントフォルダを実行ファイルと同じフォルダに設定します。このオプションを使うとカレントフォルダを変更しなくなります。（このオプションを使うと、日本語フォルダ下などではうまく動かなくなる可能性があるので注意してください。）</dd>
   <dt>--pause-last</dt>
   <dt>--no-pause-last</dt>
   <dd>実行の最後に、pause を入れるか否かを設定します。省略した場合、コンソールアプリ（後述）の場合 on に、ウィンドウアプリの場合 off になります。</dd>
@@ -108,29 +110,23 @@ Neri はデフォルトでは、enc フォルダ内の文字コードライブ
   <dt>--encryption-key &lt;key&gt;</dt>
   <dd>データファイルの暗号化キーを設定します。省略した場合、暗号化は行われません。
   暗号化は簡単なものなので、解読されては困るような重要なデータには用いないでください。</dd>
+  <dt>--virtual-directory &lt;dirname&gt;</dt>
+  <dd>データファイルからファイルを読み出す際、Neri はまず実行時のカレントフォルダをもとにファイルを検索し、見つからない場合はこの virtual-directory をもとにファイルを検索します。省略した場合は自動的に適切な仮想パスを生成します。</dd>
 </dl>
 
 #### exe ファイルの作成
 
 <dl>
-  <dt>--no-exe</dt>
+  <dt>--no-exe or --bat</dt>
   <dd>exe ファイルは作成せず、bat ファイルを作成します。</dd>
-  <dt>--use-b2ec</dt>
-  <dd>exe ファイルの作成を、Bat To Exe Converter を用いて行うようにします。</dd>
-  <dt>--b2ec-path &lt;bat_to_exe_converter_path&gt;</dt>
-  <dd>Bat To Exe Converter がパスの通ったところにない場合、このオプションで場所を指定してください。</dd>
   <dt>--icon &lt;iconfile&gt;</dt>
   <dd>アイコンを設定します。</dd>
   <dt>--windows or --invisible</dt>
   <dt>--console or --visible</dt>
   <dd>ウィンドウアプリにするかコンソールアプリにするかを設定します。
   ウィンドウアプリの場合、いわゆる「DOS窓」が開きません。
-  省略した場合、実行スクリプトファイルの拡張子が ".rbw" の場合、あるいは DXRuby を使用する場合にはウィンドウアプリになります。
+  省略した場合、実行スクリプトファイルの拡張子が ".rbw" の場合、あるいは [DXRuby](http://dxruby.osdn.jp/) や [Gosu](https://www.libgosu.org/ruby.html), [LibUI](https://github.com/kojix2/libui) を使用する場合にはウィンドウアプリになります。
   そうでない場合はコンソールアプリになります。</dd>
-  <dt>--x64</dt>
-  <dd>64bit の exe ファイルを作成します。省略した場合、ruby 自体の bit 数に合わせます。 ※ Bat To Exe Converter 使用時のみ有効</dd>
-  <dt>--uac-admin</dt>
-  <dd>管理者として実行する exe ファイルを作成します。 ※ Bat To Exe Converter 使用時のみ有効</dd>
   <dt>--fileversion &lt;version&gt;</dt>
   <dt>--productversion &lt;version&gt;</dt>
   <dd>ファイルバージョン・製品バージョンを設定します。
@@ -148,56 +144,21 @@ Neri はデフォルトでは、enc フォルダ内の文字コードライブ
   <dd>コメント等を設定します。</dd>
 </dl>
 
-#### UPX
-
-[UPX](https://upx.github.io/) を使用することで、全体のファイルサイズを小さくすることができます。
-
-<dl>
-  <dt>--use-upx</dt>
-  <dd>UPX を使用します。</dd>
-  <dt>--upx-path &lt;upx path&gt;</dt>
-  <dd>UPX がパスの通ったところにない場合、このオプションで場所を指定してください。</dd>
-  <dt>--upx_targets '&lt;glob&gt;'</dt>
-  <dd>UPX を適用するファイルを指定します。デフォルトは 'bin/**/*.dll' です。</dd>
-  <dt>--upx-options &lt;options&gt;</dt>
-  <dd>UPX に渡すオプションを設定します。</dd>
-</dl>
-
-#### 7-Zip
-
-[7-Zip](http://7-zip.org/) を使用することで、出力ファイルをまとめて zip ファイルにすることができます。
+### neri.config ファイルによる設定
 
-<dl>
-  <dt>--zipfile &lt;filename&gt;</dt>
-  <dd>zip ファイルを作成します。</dd>
-  <dt>--7zip-path &lt;7-zip path&gt;</dt>
-  <dd>7-Zip がパスの通ったところにない場合、このオプションで場所を指定してください。</dd>
-</dl>
-
-#### Inno Setup
-
-[Inno Setup](http://www.jrsoftware.org/isinfo.php) を使用することで、インストーラーを作成することができます。※ あまりテストしていません。
-
-<dl>
-  <dt>--innosetup &lt;inno_script&gt;</dt>
-  <dd>.iss ファイルを指定します。</dd>
-  <dt>--iscc-path &lt;iscc path&gt;</dt>
-  <dd>iscc がパスの通ったところにない場合、このオプションで場所を指定してください。</dd>
-</dl>
+HOME フォルダ、あるいはカレントフォルダに`neri.config`というファイルを用意しておくと、以上のオプションをいちいち入力しなくても、`neri.config`に書かれたオプション設定を使用します。
 
-#### レシピファイル
+`neri.config`には上記のオプションを、下のように改行で区切って入力してください。
 
-見てのとおり Neri の設定は多岐にわたるので、さまざまな設定を毎回入力するのは大変です。
-そこで、それらの設定を「レシピファイル」として保存・適用することができます。
+```
+--icon myicon.ico
+--encryption-key foo
+--output-dir ../bar
+```
 
-<dl>
-  <dt>--create-recipe &lt;recipefile&gt;</dt>
-  <dd>レシピファイルを作成します。このオプションを指定した場合、実行ファイルの作成は行いません。</dd>
-  <dt>--recipe &lt;recipefile&gt;</dt>
-  <dd>レシピファイルを適用して、実行ファイルを作成します。</dd>
-</dl>
+コマンドラインオプション←カレントフォルダ←ホームフォルダの順で優先されます。
 
-## データファイルの活用
+## データファイルを活用したファイルの簡易隠蔽機能
 
 たとえば以下のようにすることで、script.rb だけでなく、data フォルダ内のデータ一式をデータファイルに収めることができます。
 
@@ -225,11 +186,31 @@ Neri.files # -> Array
 
 データファイル内にあるファイルの一覧を配列で返します。
 
-### [DXRuby](http://dxruby.osdn.jp/) 等との連携
+### DXRuby 等との連携
 
 DXRuby を使用する場合、DXRuby の Image.load, Image.load_tiles, Sound.new を上書きし、データファイル内に画像・音声ファイルがあればそちらから読み込むようになります。
 これにより、スクリプトファイルを一切書き換えることなく、Neri を利用したファイルの簡易隠蔽機能が利用できます。
 
+### その他
+
+#### 実行ファイル作成時のみ、スクリプトを早期に終了させたい場合
+
+Neri は依存ファイルチェックのためにスクリプトを一度実行するので、その終了を待つか途中で強制終了させる必要があります。しかし、実行ファイル作成時には `NeriBuild` というモジュールが存在するので、以下のように `NeriBuild` が存在する場合は早期に終了するようにすることができます。
+
+```ruby
+require "foobar"
+# 必要なライブラリの読み込みがすべて終了
+exit if defined? NeriBuild
+```
+
+#### 実行ファイルのパス
+
+Neri で作られた実行ファイルを実行すると、環境変数 `NERI_EXECUTABLE` に実行ファイルのパスが保存されます。
+
+```ruby
+puts ENV["NERI_EXECUTABLE"]
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nodai2hITC/neri

data/README.md

@@ -1,75 +1,216 @@
 # Neri
 
-[日本語説明（こちらの方が詳細）](https://github.com/nodai2hITC/neri/blob/master/README.ja.md)
+[日本語説明](https://github.com/nodai2hITC/neri/blob/master/README.ja.md)
+
+Neri is a packaging system for distributing Ruby scripts on Windows without Ruby installation.
+
+There is a similar gem [OCRA](https://github.com/larsch/ocra), but Neri has the following differences.
+
+- Advantages compared to OCRA
+  - Faster startup due to no expansion.
+  - When you want to create multiple executable files, OCRA generates multiple large executable files, but Neri can share system files, so the overall size is not large.
+- Disadvantages compared to OCRA
+  - Basically, Neri can be used only in the environment where Ruby is installed by [Ruby Installer 2](https://rubyinstaller.org/) With Devkit. (Also, you need to run `ridk enable` to pass it before use.)
 
 ## Installation
 
     $ gem install neri
 
-## Usage
+It is also possible to use Neri with bundler, but it is not recommended because it increases the number of files to be included.
+
+## How to use
+
+First, you need to run `ridk enable` to set pass to the development environment.
 
     $ neri [options] script.rb (other_files...) -- script_arguments
 
+In the example above, Neri run "script.rb" once to check for dependency files, and then copy the files you need as dependency files to the output folder.
+And then create the executable file.
+
+If you copy the entire output folder, you can run the script even in an environment without Ruby.
+
+### options:
+
+#### Basic options
+
+<dl>
+  <dt>--help or -h</dt>
+  <dd>Show help.</dd>
+  <dt>--version or -v</dt>
+  <dd>Show version of Neri.</dd>
+  <dt>--quiet</dt>
+  <dd>It will no longer display the progress during execution.</dd>
+  <dt>--external-encoding</dt>
+  <dd>Set the character encoding for the output. If you encounter garbled characters when using settings such as --pause-text (see below), please make this setting.</dd>
+</dl>
+
+#### Add dependent files
+
+Neri will automatically copy the files that it thinks are necessary for execution to the output folder as dependent files.
+However, there may be cases where that determination does not work and you do not have enough files for execution.
+In such cases, you need to add the dependency files manually with these options.
+
+(or copy the necessary files directly to the output destination manually.)
+
+<dl>
+  <dt>--dll &lt;dll1&gt;,&lt;dll2&gt;,...</dt>
+  <dd>Add the specified dll file in the bin folder to the dependency files.</dd>
+  <dt>--lib &lt;lib1&gt;,&lt;lib2&gt;,...</dt>
+  <dd>Add the specified file in $LOAD_PATH to the dependency files.</dd>
+  <dt>--gem &lt;gem1&gt;,&lt;gem2&gt;,...</dt>
+  <dd>Adds the files of the specified gem to the dependency files.
+  By default, it will add the set of files in the lib folder of the gem to the dependency files. (You can use `--gem gemname:dir1|dir2` to add files other than the lib folder.)
+  Currently, the dependencies between gems are not checked, so you need to add all necessary gems manually.</dd>
+</dl>
+
+#### Encoding
+
+By default, Neri adds all encoding files in the enc folder to the dependency files, but this increases the overall file size.
+
+By specifying the encoding files to be copied with these options, you can minimize the amount of data.
+
+<dl>
+  <dt>--no-enc</dt>
+  <dd>Do not add Encoding files to the dependency files except for the ones you actually used.</dd>
+  <dt>--encoding &lt;enc1&gt;,&lt;enc2&gt;,...</dt>
+  <dd>Manually specify the encoding file to be added.</dd>
+</dl>
+
+↓ Example: Add only "windows_31j.so" and "japanese_sjis.so" to the dependency files.
+
+    $ neri --encoding windows_31j.so,japanese_sjis.so script.rb
+
+#### Setting
+
+<dl>
+  <dt>--enable-gems (default)</dt>
+  <dt>--disable-gems</dt>
+  <dd>Use rubygems. If you use --disable-gems, the necessary gem files will be copied to the vendor_ruby folder, so that you can run without rubygems.</dd>
+  <dt>--enable-did-you-mean</dt>
+  <dt>--disable-did-you-mean (default)</dt>
+  <dd>use did_you_mean</dd>
+  <dt>--no-chdir</dt>
+  <dd>By default, executables created by Neri will set the current folder to the same folder as the executable at runtime. With this option, the current folder will not be changed. (Please note that this option may not work well under Non-Ascii name folders.)</dd>
+  <dt>--pause-last</dt>
+  <dt>--no-pause-last</dt>
+  <dd>Set whether or not to include pause at the end of the execution. If omitted, it will be set to "on" for console applications (see below) and "off" for window applications.</dd>
+  <dt>--pause-text &lt;text&gt;</dt>
+  <dd>Sets the display contents when pause is applied.</dd>
+</dl>
+
+#### Output
+
+<dl>
+  <dt>--output-dir &lt;dirname&gt;</dt>
+  <dd>Specifies the output folder name. If omitted, it will be the current folder (. /).</dd>
+  <dt>--system-dir &lt;dirname&gt;</dt>
+  <dd>Specify the name of the system folder where ruby and other files will be copied. The default is "system".</dd>
+  <dt>--datafile &lt;filename&gt;</dt>
+  <dd>Specify the data file name.If omitted, the name of the data file will be the file name of the executed script file with the extension changed to ".dat".
+  If you omit this option and there is no other file to put into the data file, the data file will not be created and the executed script file will be copied directly into the system folder.</dd>
+  <dt>--encryption-key &lt;key&gt;</dt>
+  <dd>Set the encryption key for the data file. If omitted, no encryption will be performed.
+  Since encryption is simple, it cannot be used for important data that must not be decrypted.</dd>
+  <dt>--virtual-directory &lt;dirname&gt;</dt>
+  <dd>When reading a file from a data file, Neri will first search for the file based on the current folder at runtime, and if not found, it will search for the file based on this virtual-directory.
+  If omitted, Neri will automatically generate the appropriate virtual path.</dd>
+</dl>
+
+#### Creating an executable file
+
+<dl>
+  <dt>--no-exe or --bat</dt>
+  <dd>Do not create an exe file, but create a bat file.</dd>
+  <dt>--icon &lt;iconfile&gt;</dt>
+  <dd>Set the icon.</dd>
+  <dt>--windows or --invisible</dt>
+  <dt>--console or --visible</dt>
+  <dd>Set whether you want to use a windowed app or a console app.
+  If it is a windowed app, the command prompt will not open.
+  If omitted, it will be a windowed app if the executed script file extension is ".rbw", or if [DXRuby](http://dxruby.osdn.jp/), [Gosu](https://www.libgosu.org/ruby.html), or [LibUI](https://github.com/kojix2/libui) is used.
+  Otherwise, it will be a console app.</dd>
+  <dt>--fileversion &lt;version&gt;</dt>
+  <dt>--productversion &lt;version&gt;</dt>
+  <dd>Set the file version and product version.
+  Set &lt;version&gt; to four numbers separated by commas, such as 1,2,3,4.</dd>
+  <dt>--productname &lt;string&gt;</dt>
+  <dt>--internalname &lt;string&gt;</dt>
+  <dt>--description &lt;string&gt;</dt>
+  <dt>--company &lt;string&gt;</dt>
+  <dt>--trademarks &lt;string&gt;</dt>
+  <dt>--copyright &lt;string&gt;</dt>
+  <dd>Set the product name, internal name, file description, company name, trademarks, and copyrights.</dd>
+  <dt>--privatebuild &lt;string&gt;</dt>
+  <dt>--specialbuild &lt;string&gt;</dt>
+  <dt>--comments &lt;string&gt;</dt>
+  <dd>Set comments, etc.</dd>
+</dl>
+
+### Configuration by neri.config file
+
+If you create a file named `neri.config` in your HOME folder or the current folder, Neri will use the option settings written in `neri.config` without you having to enter each of the above options.
+
+Enter the above options in `neri.config`, separated by a new line as shown below.
+
+```
+--icon myicon.ico
+--encryption-key foo
+--output-dir ../bar
+```
+
+Command line options ← Current folder ← Home folder takes precedence in this order.
+
+## Simple file hiding function using the data file
+
+For example, you can put not only script.rb but also all the files in the data folder into a data file by doing the following.
+
+    $ neri script.rb data/*
+
+Script files in the data file can be loaded with `require` or `load`.
+
+Also, by adding `require 'neri'` in the original script file, you can access the files in the data file with the following methods.
+
+```ruby
+Neri.file_exist?(filename) # -> bool
 ```
-options:
-  --help or -h
-  --version or -v
-  --quiet
-  --verbose
-  
-  --dll <dll1>,<dll2>,...
-  --lib <lib1>,<lib2>,...
-  --gem <gem1>,<gem2>,...
-  
-  --no-enc
-  --encoding <enc1>,<enc2>,...
-  
-  --enable-gems
-  --enable-did-you-mean
-  --chdir-first
-  --pause-last
-  --no-pause-last
-  --pause-text <text>
-  
-  --output-dir <dirname>
-  --system-dir <dirname>
-  --data-file <filename>
-  --encryption-key <key>
-  
-  --no-exe
-  --use-b2ec
-  --b2ec-path <bat_to_exe_converter_path>
-  --icon <iconfile>
-  --windows or --invisible
-  --console or --visible
-  --x64
-  --uac-admin
-  --fileversion <string>     # ex) 1,2,3,4
-  --productversion <string>  # ex) 1,2,3,4
-  --productname <string>
-  --originalfilename <string>
-  --internalname <string>
-  --description <string>
-  --company <string>
-  --trademarks <string>
-  --copyright <string>
-  --privatebuild <string>
-  --specialbuild <string>
-  --comments <string>
-  
-  --use-upx
-  --upx-path <upx path>
-  --upx_targets '<glob>'
-  --upx-options <options>
-  
-  --zipfile <filename>
-  --7zip-path <7-zip path>
-  
-  --innosetup <inno_script>
-  --iscc-path <iscc path>
-  
-  --create-recipe <recipefile>
-  --recipe <recipefile>
+
+Returns true if the file exists in the data file or actually exists, false if it does not.
+
+```ruby
+Neri.file_read(filename, encoding = Encoding::BINARY) # -> String
+```
+
+Reads the entire file that exists in the data file or in as a real file file (the size to be read cannot be specified). If the file exists both in the data file and as a real file, the one in the data file takes precedence.
+
+```ruby
+Neri.files # -> Array
+```
+
+Returns a list of files in a data file as Array.
+
+### Cooperation with DXRuby, etc.
+
+When using DXRuby, Neri will overwrite DXRuby's Image.load, Image.load_tiles, and Sound.new, and load from the image and sound files in the data file if there are any.
+This allows you to use Neri for simple file hiding without having to rewrite any script files.
+
+### Other
+
+#### If you want to exit the script early only when the executable is created
+
+Neri executes the script once to check for dependency files, so you need to wait for it to finish or force it to quit in the middle. However, since the module `NeriBuild` is present when the executable is created, you can make it exit early if `NeriBuild` is present, as follows.
+
+```ruby
+require "foobar"
+# All necessary libraries have been loaded.
+exit if defined? NeriBuild
+```
+
+#### Path of the executable file
+
+When you run an executable created by Neri, the path of the executable will be saved in the environment variable `NERI_EXECUTABLE`.
+
+```ruby
+puts ENV["NERI_EXECUTABLE"]
 ```
 
 ## Contributing

data/exe/neri

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-# encoding: UTF-8
 
 require "neri"
 load "neri/build.rb"
 
-Neri.run()
+NeriBuild.run