Browse Source

Add a contributing section to the README and simplify package addition

Loïc Hoguin 10 years ago
parent
commit
bed9ae9b1b
4 changed files with 31 additions and 13 deletions
  1. 5 1
      Makefile
  2. 16 0
      README.md
  3. 5 6
      packages.v1.tsv
  4. 5 6
      packages.v1.txt

+ 5 - 1
Makefile

@@ -19,5 +19,9 @@ ERLANG_MK = erlang.mk
 
 
 .PHONY: all
 .PHONY: all
 
 
-all:
+all: pkg
 	awk 'FNR==1 && NR!=1{print ""}1' $(patsubst %,%.mk,$(BUILD_CONFIG)) > $(ERLANG_MK)
 	awk 'FNR==1 && NR!=1{print ""}1' $(patsubst %,%.mk,$(BUILD_CONFIG)) > $(ERLANG_MK)
+
+pkg:
+	cat packages.v2.tsv | awk 'BEGIN { FS = "\t" }; { print $$1 "\t" $$3 "\t" $$5 "\t" $$6 }' > packages.v1.tsv
+	cp packages.v1.tsv packages.v1.txt

+ 16 - 0
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
 the `RELX_OUTPUT_DIR` variable. Any other option should go
 in the `RELX_OPTS` variable.
 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
 Support
 -------
 -------
 
 

+ 5 - 6
packages.v1.tsv

@@ -1,14 +1,13 @@
 bullet	https://github.com/extend/bullet	http://ninenines.eu	Simple, reliable, efficient streaming for Cowboy.
 bullet	https://github.com/extend/bullet	http://ninenines.eu	Simple, reliable, efficient streaming for Cowboy.
-cowboy	https://github.com/extend/cowboy	http://ninenines.eu	Small, fast and modular HTTP server.
-cowlib	https://github.com/extend/cowlib	http://ninenines.eu	Support library for manipulating Web protocols.
+cowboy	https://github.com/ninenines/cowboy	http://ninenines.eu	Small, fast and modular HTTP server.
+cowlib	https://github.com/ninenines/cowlib	http://ninenines.eu	Support library for manipulating Web protocols.
+eper	https://github.com/massemanet/eper	https://github.com/massemanet/eper	Erlang performance and debugging tools.
+epgsql	https://github.com/epgsql/epgsql	https://github.com/epgsql/epgsql	Erlang PostgreSQL client library.
 erlydtl	https://github.com/erlydtl/erlydtl	https://github.com/erlydtl/erlydtl	Django Template Language for Erlang.
 erlydtl	https://github.com/erlydtl/erlydtl	https://github.com/erlydtl/erlydtl	Django Template Language for Erlang.
-eper	https://github.com/massemanet/eper	https://github.com/massemanet/eper	Erlang Performance and debugging tools.
-farwest_core	https://github.com/extend/farwest_core	http//ninenines.eu	Modern web application development platform.
-farwest_ui	https://github.com/extend/farwest_ui	http://ninenines.eu	Development and administration UI for Farwest.
 gun	https://github.com/extend/gun	http//ninenines.eu	Asynchronous SPDY, HTTP and Websocket client written in Erlang.
 gun	https://github.com/extend/gun	http//ninenines.eu	Asynchronous SPDY, HTTP and Websocket client written in Erlang.
 jsx	https://github.com/talentdeficit/jsx	https://github.com/talentdeficit/jsx	An Erlang application for consuming, producing and manipulating JSON.
 jsx	https://github.com/talentdeficit/jsx	https://github.com/talentdeficit/jsx	An Erlang application for consuming, producing and manipulating JSON.
 neo4j	https://github.com/dmitriid/neo4j-erlang	https://github.com/dmitriid/neo4j-erlang	Erlang client library for Neo4J.
 neo4j	https://github.com/dmitriid/neo4j-erlang	https://github.com/dmitriid/neo4j-erlang	Erlang client library for Neo4J.
 pegjs	https://github.com/dmitriid/pegjs	https://github.com/dmitriid/pegjs	An implementation of PEG.js grammar for Erlang.
 pegjs	https://github.com/dmitriid/pegjs	https://github.com/dmitriid/pegjs	An implementation of PEG.js grammar for Erlang.
 proper	https://github.com/manopapad/proper	http://proper.softlab.ntua.gr	PropEr: a QuickCheck-inspired property-based testing tool for Erlang.
 proper	https://github.com/manopapad/proper	http://proper.softlab.ntua.gr	PropEr: a QuickCheck-inspired property-based testing tool for Erlang.
-ranch	https://github.com/extend/ranch	http://ninenines.eu	Socket acceptor pool for TCP protocols.
+ranch	https://github.com/ninenines/ranch	http://ninenines.eu	Socket acceptor pool for TCP protocols.
 sheriff	https://github.com/extend/sheriff	http://ninenines.eu	Parse transform for type based validation.
 sheriff	https://github.com/extend/sheriff	http://ninenines.eu	Parse transform for type based validation.

+ 5 - 6
packages.v1.txt

@@ -1,14 +1,13 @@
 bullet	https://github.com/extend/bullet	http://ninenines.eu	Simple, reliable, efficient streaming for Cowboy.
 bullet	https://github.com/extend/bullet	http://ninenines.eu	Simple, reliable, efficient streaming for Cowboy.
-cowboy	https://github.com/extend/cowboy	http://ninenines.eu	Small, fast and modular HTTP server.
-cowlib	https://github.com/extend/cowlib	http://ninenines.eu	Support library for manipulating Web protocols.
+cowboy	https://github.com/ninenines/cowboy	http://ninenines.eu	Small, fast and modular HTTP server.
+cowlib	https://github.com/ninenines/cowlib	http://ninenines.eu	Support library for manipulating Web protocols.
+eper	https://github.com/massemanet/eper	https://github.com/massemanet/eper	Erlang performance and debugging tools.
+epgsql	https://github.com/epgsql/epgsql	https://github.com/epgsql/epgsql	Erlang PostgreSQL client library.
 erlydtl	https://github.com/erlydtl/erlydtl	https://github.com/erlydtl/erlydtl	Django Template Language for Erlang.
 erlydtl	https://github.com/erlydtl/erlydtl	https://github.com/erlydtl/erlydtl	Django Template Language for Erlang.
-eper	https://github.com/massemanet/eper	https://github.com/massemanet/eper	Erlang Performance and debugging tools.
-farwest_core	https://github.com/extend/farwest_core	http//ninenines.eu	Modern web application development platform.
-farwest_ui	https://github.com/extend/farwest_ui	http://ninenines.eu	Development and administration UI for Farwest.
 gun	https://github.com/extend/gun	http//ninenines.eu	Asynchronous SPDY, HTTP and Websocket client written in Erlang.
 gun	https://github.com/extend/gun	http//ninenines.eu	Asynchronous SPDY, HTTP and Websocket client written in Erlang.
 jsx	https://github.com/talentdeficit/jsx	https://github.com/talentdeficit/jsx	An Erlang application for consuming, producing and manipulating JSON.
 jsx	https://github.com/talentdeficit/jsx	https://github.com/talentdeficit/jsx	An Erlang application for consuming, producing and manipulating JSON.
 neo4j	https://github.com/dmitriid/neo4j-erlang	https://github.com/dmitriid/neo4j-erlang	Erlang client library for Neo4J.
 neo4j	https://github.com/dmitriid/neo4j-erlang	https://github.com/dmitriid/neo4j-erlang	Erlang client library for Neo4J.
 pegjs	https://github.com/dmitriid/pegjs	https://github.com/dmitriid/pegjs	An implementation of PEG.js grammar for Erlang.
 pegjs	https://github.com/dmitriid/pegjs	https://github.com/dmitriid/pegjs	An implementation of PEG.js grammar for Erlang.
 proper	https://github.com/manopapad/proper	http://proper.softlab.ntua.gr	PropEr: a QuickCheck-inspired property-based testing tool for Erlang.
 proper	https://github.com/manopapad/proper	http://proper.softlab.ntua.gr	PropEr: a QuickCheck-inspired property-based testing tool for Erlang.
-ranch	https://github.com/extend/ranch	http://ninenines.eu	Socket acceptor pool for TCP protocols.
+ranch	https://github.com/ninenines/ranch	http://ninenines.eu	Socket acceptor pool for TCP protocols.
 sheriff	https://github.com/extend/sheriff	http://ninenines.eu	Parse transform for type based validation.
 sheriff	https://github.com/extend/sheriff	http://ninenines.eu	Parse transform for type based validation.