aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-08-05 12:04:33 +0200
committerLoïc Hoguin <[email protected]>2014-08-05 12:04:33 +0200
commitbed9ae9b1b85bb4f13a59b360b04a549e70ab2ee (patch)
tree9322180efff110778d4bb24d2458b55823db125a /README.md
parentb582edba733b08b92c8e3eb180d9d081fd523cb6 (diff)
downloaderlang.mk-bed9ae9b1b85bb4f13a59b360b04a549e70ab2ee.tar.gz
erlang.mk-bed9ae9b1b85bb4f13a59b360b04a549e70ab2ee.tar.bz2
erlang.mk-bed9ae9b1b85bb4f13a59b360b04a549e70ab2ee.zip
Add a contributing section to the README and simplify package addition
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2a496d5..c3e4e93 100644
--- a/README.md
+++ b/README.md
@@ -322,6 +322,22 @@ You can change the generated releases location by setting
the `RELX_OUTPUT_DIR` variable. Any other option should go
in the `RELX_OPTS` variable.
+Contributing
+------------
+
+You can contribute by providing feedback, creating patches,
+adding packages to the index or new features as plugins.
+
+For packages, you only need to edit the `packages.v2.tsv`
+file, adding your package (they are sorted alphabetically),
+and then running `make` to update the older files kept for
+compatibility reasons.
+
+For patches or plugins, you have to edit the `core/*.mk`
+or `plugins/*.mk` files and then run `make` to create an
+updated `erlang.mk`. If you submit a new plugin, you also
+need to add it to the `build.config` file.
+
Support
-------