aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTristan Sloughter <[email protected]>2013-03-11 19:37:17 -0500
committerTristan Sloughter <[email protected]>2013-03-13 13:43:01 -0500
commit937c776c131c9e2e04aefc6b4f320e37b35115c2 (patch)
treee7ab10b5bf5724790b2b766d5993fa5e44dbc128 /README.md
parent279ab4bf7ae5baa51638710a8967d86b3d4cf5ae (diff)
downloadrelx-937c776c131c9e2e04aefc6b4f320e37b35115c2.tar.gz
relx-937c776c131c9e2e04aefc6b4f320e37b35115c2.tar.bz2
relx-937c776c131c9e2e04aefc6b4f320e37b35115c2.zip
copy start_clean boot file along with erts
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*