Browse Source

Add a Requirements section to Readme

Thanks Kenji Rikitake.
Loïc Hoguin 11 years ago
parent
commit
4a1942695b
1 changed files with 9 additions and 0 deletions
  1. 9 0
      README.md

+ 9 - 0
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
 -----