aboutsummaryrefslogtreecommitdiffstats
path: root/index.md
diff options
context:
space:
mode:
authorTristan Sloughter <[email protected]>2013-09-21 11:43:48 -0500
committerTristan Sloughter <[email protected]>2013-09-21 11:43:48 -0500
commit32db43885ab2db7c762a37f6794ee14181ca2170 (patch)
tree864a29c5cd68f3319f7764bdc84b750675e77e82 /index.md
parentdfdd4deb4a2d1bab985a315be32810eeaf72f914 (diff)
downloadrelx-32db43885ab2db7c762a37f6794ee14181ca2170.tar.gz
relx-32db43885ab2db7c762a37f6794ee14181ca2170.tar.bz2
relx-32db43885ab2db7c762a37f6794ee14181ca2170.zip
convert generated page to markdown
Diffstat (limited to 'index.md')
-rw-r--r--index.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/index.md b/index.md
new file mode 100644
index 0000000..fed1217
--- /dev/null
+++ b/index.md
@@ -0,0 +1,27 @@
+---
+layout: default
+title: Relx by erlware
+---
+
+Relx 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.
+
+## Example Configuration
+
+{% highlight bash %}
+$ git clone https://github.com/tsloughter/erlangdc2013.git
+$ cd erlangdc2013
+$ cat relx.config
+{release, {erlangdc, "0.0.1"},
+ [estatsd
+ ,erlangdc]}.
+{extended_start_script, true}.
+
+$ ./relx
+...
+$ ls _rel/
+bin erts-5.10.1 lib log releases
+{% endhighlight %}
+
+### Documentation
+
+* [wiki](http://github.com/erlware/relx/wiki)