aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-10-29 09:39:29 +0100
committerLoïc Hoguin <[email protected]>2013-10-29 09:39:29 +0100
commit4a1942695b8aa000e22ac5533474725dc7690ec6 (patch)
treec293cb7fe4454d9a5d346dc11684e1426fbaac48 /README.md
parentae1086a37c59e1723e4e2536129313eb626281d5 (diff)
downloaderlang.mk-4a1942695b8aa000e22ac5533474725dc7690ec6.tar.gz
erlang.mk-4a1942695b8aa000e22ac5533474725dc7690ec6.tar.bz2
erlang.mk-4a1942695b8aa000e22ac5533474725dc7690ec6.zip
Add a Requirements section to Readme
Thanks Kenji Rikitake.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index feda782..00711a4 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,15 @@ Common Makefile rules for building and testing Erlang applications.
Also features support for dependencies and a package index.
+Requirements
+------------
+
+`erlang.mk` requires GNU Make and expects to be ran in a standard
+unix environment with Erlang installed and in the `$PATH`.
+
+`erlang.mk` uses `wget` for downloading the package index file
+when the `pkg://` scheme is used.
+
Usage
-----