aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEric Merritt <[email protected]>2013-03-13 11:46:03 -0700
committerEric Merritt <[email protected]>2013-03-13 11:46:03 -0700
commitc7fd47264688ff74adafc18269a378c14742b284 (patch)
tree6c491fddb665ae86cb6113749549b7ca635ffc73 /README.md
parent6734e9ec4e0dd4c0678d10e8b8e48552ffb4e995 (diff)
parentb69815402b3456699a47273a8c731850fb6b7871 (diff)
downloadrelx-c7fd47264688ff74adafc18269a378c14742b284.tar.gz
relx-c7fd47264688ff74adafc18269a378c14742b284.tar.bz2
relx-c7fd47264688ff74adafc18269a378c14742b284.zip
Merge pull request #30 from tsloughter/next
Update readme, fix test, generate erl script with proper paths, copy start_clean.boot if config opt set
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5407002..419bc50 100644
--- a/README.md
+++ b/README.md
@@ -14,11 +14,19 @@ applications it will generate a release output. That output depends
heavily on what plugins available and what options are defined, but
usually it is simple a well configured release directory.
- relcool -c relcool.config -l ~/my-dirs --relname foo --relvsn 0.0.1 --target-spec myapp --target-spec getopt>=0.5.1 -o output-dir
+ relcool -c relcool.config -l ~/my-dirs --relname foo --relvsn 0.0.1 --target-spec myapp --target-spec getopt>=0.5.1 -o output-dir
The *release-specification-file* is optional but otherwise contains
additional specification information for releases.
+# BUILDING
+
+To build relcool and generate a standalone escript executable:
+
+ $ make escript
+
+This creates the executable `relcool`.
+
# OPTIONS
-r *STRING*, \--root *STRING*