aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEric <[email protected]>2013-05-09 17:13:06 -0700
committerEric <[email protected]>2013-05-10 11:09:49 -0700
commitc5f0a8c9175b2d152c69f72da15e7ceff411f86b (patch)
tree1ae9a327feeb420983f9a85fdb6c800900369480 /README.md
parentefbdfbe117939cd50d0252a210b9b7634de42bb4 (diff)
downloadrelx-c5f0a8c9175b2d152c69f72da15e7ceff411f86b.tar.gz
relx-c5f0a8c9175b2d152c69f72da15e7ceff411f86b.tar.bz2
relx-c5f0a8c9175b2d152c69f72da15e7ceff411f86b.zip
internal rename completion of all relcool to relx calls
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index b235f37..e7d0655 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
-[![Build Status](https://travis-ci.org/erlware/relcool.png)](https://travis-ci.org/erlware/relcool)
+[![Build Status](https://travis-ci.org/erlware/relx.png)](https://travis-ci.org/erlware/relx)
# NAME
-relcool - A release assembler for erlang
+relx - A release assembler for erlang
# SYNOPSIS
-relcool [*options*] [*release-specification-file*]
+relx [*options*] [*release-specification-file*]
# DESCRIPTION
@@ -16,18 +16,18 @@ 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
+ relx -c relx.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:
+To build relx and generate a standalone escript executable:
$ make
-This creates the executable `relcool`.
+This creates the executable `relx`.
# OPTIONS
@@ -54,7 +54,7 @@ This creates the executable `relcool`.
: The verbosity level of the system. Valid values are 1 - 3
-c *INTEGER*, \--config *INTEGER*
-: The custom config file for the relcool system
+: The custom config file for the relx system
# CONFIGURATION FILES
@@ -64,4 +64,4 @@ Configuration files
`reltool` (1).
-[relcool wiki](https://github.com/erlware/relcool/wiki)
+[relx wiki](https://github.com/erlware/relx/wiki)