aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-05-28 20:45:55 +0200
committerLoïc Hoguin <[email protected]>2013-05-28 20:46:34 +0200
commit2000831c46afb1df84402a3e0eb172695ee29128 (patch)
treee061442b6d0f307d4fae19b1d65d2906757c98f0 /README.md
parent9f3a42a730a38a92846995170aa29280cc284529 (diff)
downloaderlang.mk-2000831c46afb1df84402a3e0eb172695ee29128.tar.gz
erlang.mk-2000831c46afb1df84402a3e0eb172695ee29128.tar.bz2
erlang.mk-2000831c46afb1df84402a3e0eb172695ee29128.zip
Add the list of compiled files to the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 451fab3..5f85a73 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,20 @@ dep_ct_helper = https://github.com/extend/ct_helper.git master
Please note that the test dependencies will only be compiled once
when they are fetched, unlike the normal dependencies.
+Compiled files
+--------------
+
+The following files will be automatically compiled:
+
+| Wildcard | Description |
+| ------------------ | ----------------------------- |
+| `src/*.app.src | OTP application resource file |
+| `src/*.erl` | Erlang source files |
+| `src/*.core` | Core Erlang source files |
+| `templates/*.dtl` | ErlyDTL template files |
+
+Only the `.app.src` file and at least one `.erl` file are required.
+
Commands
--------