From bed9ae9b1b85bb4f13a59b360b04a549e70ab2ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 5 Aug 2014 12:04:33 +0200 Subject: Add a contributing section to the README and simplify package addition --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'README.md') 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 ------- -- cgit v1.2.3