aboutsummaryrefslogtreecommitdiffstats
path: root/README.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-12-30 11:44:47 +0100
committerLoïc Hoguin <[email protected]>2015-12-30 11:44:47 +0100
commit730c33ebe9e507b3209802edb6759891ba28bb56 (patch)
treeb8448f7f990ff44c0fd8dae661b1f066be998441 /README.asciidoc
parent8a2f44eb607d53f5627df53438b2e9ad3b81409c (diff)
downloaderlang.mk-730c33ebe9e507b3209802edb6759891ba28bb56.tar.gz
erlang.mk-730c33ebe9e507b3209802edb6759891ba28bb56.tar.bz2
erlang.mk-730c33ebe9e507b3209802edb6759891ba28bb56.zip
Write a new README, keep parts of the old one as legacy
Diffstat (limited to 'README.asciidoc')
-rw-r--r--README.asciidoc18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.asciidoc b/README.asciidoc
new file mode 100644
index 0000000..c397291
--- /dev/null
+++ b/README.asciidoc
@@ -0,0 +1,18 @@
+= Erlang.mk
+
+A build tool for Erlang that just works.
+
+http://erlang.mk/ - http://erlang.mk/guide/[User guide]
+
+Embrace the power and simplicity of Makefiles.
+
+[source,make]
+PROJECT = webchat
+DEPS = cowboy
+include erlang.mk
+
+http://erlang.mk/guide/getting_started.html[Get started]
+
+Tested and supported on
+http://erlang.mk/guide/installation.html#_on_unix[Linux, FreeBSD, OSX]
+and http://erlang.mk/guide/installation.html#_on_windows[Windows].