diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -31,6 +31,21 @@ To build relx and generate a standalone escript executable: This creates the executable `relx`. +Note, if using your own `rebar`, it must at least be > version [2.2.0](https://github.com/rebar/rebar/releases) + +Building on Windows +------------------- + +To build relx on Windows you'll need to have rebar installed and the path to +the rebar binary added to the `PATH` environment variable. To start the build +use the `bootstrap` batch file: + + c:\> bootstrap + +This creates the executable `relx` and the `relx.cmd` shortcut script. Copy +both of these files to a directory and make the directory available to the +`PATH` environment variable. + Config File ----------- @@ -62,6 +77,7 @@ Options | -a | --override_app | string | | An app name and a directory to override in the form appname:dir | | -c | --config | string | ./relx.config | Config file path | | | --overlay_vars | string | | Path to a file of overlay variables | +| | --sys_config | string | | Path to a file to use for sys.config | | -d | --dev-mode | boolean | false | Symlink all applications and configuration into the release instead of copying| Wiki ---- |