Split README in README.md and CONTRIBUTING.md
authorEtienne CHAMPETIER <champetier.etienne@gmail.com>
Tue, 22 Jul 2014 22:53:35 +0000 (00:53 +0200)
committerEtienne CHAMPETIER <champetier.etienne@gmail.com>
Tue, 22 Jul 2014 22:57:08 +0000 (00:57 +0200)
see https://github.com/blog/1184-contributing-guidelines

Signed-off-by: Etienne CHAMPETIER <champetier.etienne@gmail.com>
CONTRIBUTING.md [new file with mode: 0644]
README [deleted file]
README.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..f9b6c45
--- /dev/null
@@ -0,0 +1,11 @@
+# Contributing Guidelines
+
+Please make sure that all packages you commit or request to pull:
+* Package a version which is still maintained by the upstream author.
+* Have yourself or another person listed in the (PKG_)MAINTAINER field.
+* Will be updated regularly to maintained and supported versions.
+* Have no dependencies outside the openwrt core packages or this feed.
+
+Please sign-off all your commits / pull requests to this repository. See:
+https://dev.openwrt.org/wiki/SubmittingPatches#a10.Signyourwork
+
diff --git a/README b/README
deleted file mode 100644 (file)
index b7c5697..0000000
--- a/README
+++ /dev/null
@@ -1,24 +0,0 @@
-* Description *
-
-This is the OpenWrt "packages"-feed containing community-maintained packages.
-
-
-* Usage *
-
-This feed is enabled by default. To install all its package definitions:
-
-Run: ./scripts/feeds update packages
-Run: ./scripts/feeds install -a -p packages
-
-* Package Guidelines *
-
-Please make sure that all packages you commit or request to pull:
-       * Package a version which is still maintained by the upstream author.
-        * Have yourself or another person listed in the (PKG_)MAINTAINER field.
-       * Will be updated regularly to maintained and supported versions. 
-       * Have no dependencies outside the openwrt core packages or this feed.
-
-Please sign-off your commits / pull requests to this repository. See:
-https://dev.openwrt.org/wiki/SubmittingPatches#a10.Signyourwork
-
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..70c7524
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# OpenWRT packages feed
+
+## Description
+
+This is the OpenWrt "packages"-feed containing community-maintained packages.
+
+## Usage
+
+This feed is enabled by default. To install all its package definitions:
+
+Run: ./scripts/feeds update packages
+Run: ./scripts/feeds install -a -p packages
+
+## License
+
+See [LICENSE](LICENSE) file.
+## Package Guidelines
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) file.
+