aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-05-01 12:24:34 +0200
committerLoïc Hoguin <[email protected]>2013-05-01 12:24:34 +0200
commit8e770f9672d8a40c11496d3f5561f11a7fa0c4f1 (patch)
tree3c92c17aa94610053e1fea4020378373b3124298 /README.md
parentdc122adbaaedc7258704c628e3b2068368e0b59e (diff)
downloaderlang.mk-8e770f9672d8a40c11496d3f5561f11a7fa0c4f1.tar.gz
erlang.mk-8e770f9672d8a40c11496d3f5561f11a7fa0c4f1.tar.bz2
erlang.mk-8e770f9672d8a40c11496d3f5561f11a7fa0c4f1.zip
Add documentation for the targets defined
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
index a8794a6..263c78d 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,37 @@ dep_bullet = https://github.com/extend/bullet.git 0.4.1
They will always be compiled using the command `make`.
+Commands
+--------
+
+The following targets are defined:
+
+| Targets | Description |
+| ------------ | -------------------------------------------- |
+| `all` | Compile the application and all dependencies |
+| `clean-all` | Clean the application and all dependencies |
+| `app` | Compile the application |
+| `clean` | Clean the application |
+| `deps` | Compile the dependencies |
+| `clean-deps` | Clean the dependencies |
+| `docs` | Generate the Edoc documentation |
+| `clean-docs` | Clean the Edoc documentation |
+| `tests` | Run the common_test suites |
+| `build-plt` | Generate the PLT needed by Dialyzer |
+| `dialyze` | Run Dialyzer on the application |
+
+Cleaning means removing all generated and temporary files.
+
+Dependencies are fetched as soon as a command involving them is
+invoked. This means that most of the targets will trigger a
+dependency fetch. It is only done once per dependency.
+
+The default target when calling `make` is `all`.
+
+You can combine targets to perform many operations. For example, the
+shell command `make clean app` will have the effect of recompiling
+the application fully, without touching the dependencies.
+
Options
-------
@@ -69,6 +100,9 @@ Extra targets
If you need more functionality out of your Makefile, you can add extra
targets after the include line.
+Defining a target before the include line will override the default
+target `all`.
+
Support
-------