Permalink
Browse files

Point further development to relx instead of relcool

  • Loading branch information...
1 parent d269828 commit 5b582a21efe24459bbc6ef9e095b448768d4d2e8 @ericbmerritt ericbmerritt committed May 15, 2013
Showing with 5 additions and 66 deletions.
  1. +5 −66 README.md
View
71 README.md
@@ -1,67 +1,6 @@
-[![Build Status](https://travis-ci.org/erlware/relcool.png)](https://travis-ci.org/erlware/relcool)
+Relcool has been renamed to Relx!
+=================================
-# NAME
-
-relcool - A release assembler for erlang
-
-# SYNOPSIS
-
-relcool [*options*] [*release-specification-file*]
-
-# DESCRIPTION
-
-Reltool assembles releases for an Erlang/OTP release. Given a release
-specification and a list of directories in which to search for OTP
-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
-
-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
-
-This creates the executable `relcool`.
-
-# OPTIONS
-
--r *STRING*, \--root *STRING*
-: Specify the root directory for the project (if different from cwd)
-
--n *STRING*, \--relname *STRING*
-: Specify the name for the release that will be generated
-
--v *STRING*, \--relvsn=*STRING*
-: Specify the version for the release
-
--g *STRING*, \--goals *STRING*
-: Specify a goal to the system. These are usually the OTP
- Apps that are part of the release
-
--o *STRING*, \--output-dir *STRING*
-: The output directory for the release. This is `./` by default.
-
--l *STRING*, \--lib-dir *STRING*
-: Additional dirs that should be searched for OTP Apps
-
--V *INTEGER*, \--verbose *INTEGER*
-: The verbosity level of the system. Valid values are 1 - 3
-
--c *INTEGER*, \--config *INTEGER*
-: The custom config file for the relcool system
-
-# CONFIGURATION FILES
-
-Configuration files
-
-# SEE ALSO
-
-`reltool` (1).
-
-[relcool wiki](https://github.com/erlware/relcool/wiki)
+Further development will happen at
+https://github.com/erlware/relx. Please migrate your references to
+relcool there.

0 comments on commit 5b582a2

Please sign in to comment.