Browse Source

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>
Etienne CHAMPETIER 10 years ago
parent
commit
4569203e84
3 changed files with 32 additions and 24 deletions
  1. 11
    0
      CONTRIBUTING.md
  2. 0
    24
      README
  3. 21
    0
      README.md

+ 11
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,11 @@
1
+# Contributing Guidelines
2
+
3
+Please make sure that all packages you commit or request to pull:
4
+* Package a version which is still maintained by the upstream author.
5
+* Have yourself or another person listed in the (PKG_)MAINTAINER field.
6
+* Will be updated regularly to maintained and supported versions.
7
+* Have no dependencies outside the openwrt core packages or this feed.
8
+
9
+Please sign-off all your commits / pull requests to this repository. See:
10
+https://dev.openwrt.org/wiki/SubmittingPatches#a10.Signyourwork
11
+

+ 0
- 24
README View File

@@ -1,24 +0,0 @@
1
-* Description *
2
-
3
-This is the OpenWrt "packages"-feed containing community-maintained packages.
4
-
5
-
6
-* Usage *
7
-
8
-This feed is enabled by default. To install all its package definitions:
9
-
10
-Run: ./scripts/feeds update packages
11
-Run: ./scripts/feeds install -a -p packages
12
-
13
- 
14
-* Package Guidelines *
15
-
16
-Please make sure that all packages you commit or request to pull:
17
-	* Package a version which is still maintained by the upstream author.
18
-        * Have yourself or another person listed in the (PKG_)MAINTAINER field.
19
-	* Will be updated regularly to maintained and supported versions. 
20
-	* Have no dependencies outside the openwrt core packages or this feed.
21
-
22
-Please sign-off your commits / pull requests to this repository. See:
23
-https://dev.openwrt.org/wiki/SubmittingPatches#a10.Signyourwork
24
-

+ 21
- 0
README.md View File

@@ -0,0 +1,21 @@
1
+# OpenWRT packages feed
2
+
3
+## Description
4
+
5
+This is the OpenWrt "packages"-feed containing community-maintained packages.
6
+
7
+## Usage
8
+
9
+This feed is enabled by default. To install all its package definitions:
10
+
11
+Run: ./scripts/feeds update packages
12
+Run: ./scripts/feeds install -a -p packages
13
+
14
+## License
15
+
16
+See [LICENSE](LICENSE) file.
17
+ 
18
+## Package Guidelines
19
+
20
+See [CONTRIBUTING.md](CONTRIBUTING.md) file.
21
+