aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Stokes <adam.stokes@ubuntu.com>2013-10-18 08:20:30 -0400
committerAdam Stokes <adam.stokes@ubuntu.com>2013-10-18 08:20:30 -0400
commit6484ec4d04eba1d76535e7e87eb4e87a2db7a8ae (patch)
tree8883a5daa2c434f70cd960b5f95d5cb39da50f83
parent88c2249b19a0d500f77136ac5f642c4fc7fd772f (diff)
downloadsos-6484ec4d04eba1d76535e7e87eb4e87a2db7a8ae.tar.gz
Update readme to point to contributor guidelines
Signed-off-by: Adam Stokes <adam.stokes@ubuntu.com>
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0f08496c..bae1dc7a 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,13 @@ To access to the public source code repository for this project run:
git clone git://github.com/sosreport/sosreport.git
```
-### Manual Installation ###
+### Contributors please read
+
+Because of our vibrant community and everyone does things a little differently we've setup a wiki page dedicated to [sosreport's contribution guidelines][0].
+
+In order to get your requests merged in a timely manner these guidelines are mandatory.
+
+### Manual Installation
```
to install locally (as root) ==> make install
@@ -22,7 +28,7 @@ to build an rpm ==> make rpm
to build a deb ==> make deb
```
-### Pre-built Packaging ###
+### Pre-built Packaging
Fedora/RHEL users install via yum:
@@ -37,8 +43,10 @@ apt-get install sosreport
```
-Ubuntu(Saucy 13.10) users install via apt:
+Ubuntu(Saucy 13.10 and above) users install via apt:
```
sudo apt-get install sosreport
```
+
+ [0]: https://github.com/sosreport/sosreport/wiki/Contribution-Guidelines