Split README in README.md and CONTRIBUTING.md

see https://github.com/blog/1184-contributing-guidelines

Signed-off-by: Etienne CHAMPETIER <champetier.etienne@gmail.com>
This commit is contained in:
Etienne CHAMPETIER 2014-07-23 00:53:35 +02:00
parent 7884c022ac
commit 4569203e84
3 changed files with 32 additions and 24 deletions

11
CONTRIBUTING.md Normal file
View File

@ -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

24
README
View File

@ -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

21
README.md Normal file
View File

@ -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.