svn commit: r1679093 - in /nutch/branches/2.x: README.md README.txt

[lewismc]

Author: lewismc
Date: Tue May 12 20:45:39 2015
New Revision: 1679093

URL: http://svn.apache.org/r1679093
Log:
Smarten up Nutch 2.X README for better presentation on Github

Added:
    nutch/branches/2.x/README.md
      - copied, changed from r1679089, nutch/branches/2.x/README.txt
Removed:
    nutch/branches/2.x/README.txt

Copied: nutch/branches/2.x/README.md (from r1679089, 
nutch/branches/2.x/README.txt)
URL: 
http://svn.apache.org/viewvc/nutch/branches/2.x/README.md?p2=nutch/branches/2.x/README.md&p1=nutch/branches/2.x/README.txt&r1=1679089&r2=1679093&rev=1679093&view=diff
==============================================================================
--- nutch/branches/2.x/README.txt (original)
+++ nutch/branches/2.x/README.md Tue May 12 20:45:39 2015
@@ -1,4 +1,6 @@
-Apache Nutch README
+# Apache Nutch README
+
+<img src="http://nutch.apache.org/assets/img/nutch_logo_tm.png"; align="right" 
width="300" />
 
 For the latest information about Nutch, please visit our website at:
 
@@ -11,8 +13,29 @@ and our wiki, at:
 To get started using Nutch read Tutorial:
 
    http://wiki.apache.org/nutch/Nutch2Tutorial
-   
-Export Control
+
+# Contributing
+
+To contribute a patch, follow these instructions (note that installing
+[Hub](http://hub.github.com) is not strictly required, but is recommended).
+
+```
+0. Download and install hub.github.com
+1. File JIRA issue for your fix at https://issues.apache.org/jira/browse/NUTCH
+- you will get issue id NUTCH-xxx where xxx is the issue ID.
+2. git clone http://github.com/apache/nutch.git 
+3. cd nutch
+4. git checkout -b NUTCH-xxx
+5. edit files (please try and include a test case if possible)
+6. git status (make sure it shows what files you expected to edit)
+7. Make sure that your code complies with the Nutch codeformatting template at 
http://svn.apache.org/repos/asf/nutch/branches/2.x/eclipse-codeformat.xml, 
which is basially two space indents
+8. git add <files>
+9. git commit -m “fix for NUTCH-xxx contributed by <your username>”
+10. git fork
+11. git push -u <your git username> NUTCH-xxx
+12. git pull-request
+```
+# Export Control
 
 This distribution includes cryptographic software.  The country in which you 
 currently reside may have restrictions on the import, possession, use, and/or