From 4569203e84d6ecf8a9244731fd7d0a0f7fcae334 Mon Sep 17 00:00:00 2001 From: Etienne CHAMPETIER Date: Wed, 23 Jul 2014 00:53:35 +0200 Subject: [PATCH] Split README in README.md and CONTRIBUTING.md see https://github.com/blog/1184-contributing-guidelines Signed-off-by: Etienne CHAMPETIER --- CONTRIBUTING.md | 11 +++++++++++ README | 24 ------------------------ README.md | 21 +++++++++++++++++++++ 3 files changed, 32 insertions(+), 24 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 README create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..f9b6c45ded --- /dev/null +++ b/CONTRIBUTING.md @@ -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 index b7c56972b5..0000000000 --- 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 index 0000000000..70c7524803 --- /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. +