aboutsummaryrefslogtreecommitdiffstats
path: root/README.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.asciidoc')
-rw-r--r--README.asciidoc19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.asciidoc b/README.asciidoc
new file mode 100644
index 0000000..1faeae4
--- /dev/null
+++ b/README.asciidoc
@@ -0,0 +1,19 @@
+= LFE.mk
+
+http://lfe.io/[LFE] plugin for http://erlang.mk/[Erlang.mk]
+
+[source,make]
+----
+DEPS = lfe
+
+BUILD_DEPS = lfe.mk
+dep_lfe.mk = git https://github.com/ninenines/lfe.mk master
+DEP_PLUGINS = lfe.mk
+
+include erlang.mk
+----
+
+The command `make` will compile all LFE files in the 'src/'
+directory.
+
+The command `lfe-shell` will open an LFE shell.