create a file for other devs

tilsammans · Aug 17, 2011 · f6b4bcd · f6b4bcd
1 parent 96e6784
commit f6b4bcd
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/CHANGELOG.rdoc b/CHANGELOG.rdoc
@@ -1,6 +1,7 @@
 == master
 
 - Added simple_search method to retrieve results
+- Added DEVELOPMENT.rdoc
 
 
 == 0.4.1

diff --git a/DEVELOPMENT.rdoc b/DEVELOPMENT.rdoc
@@ -0,0 +1,11 @@
+= Working on SimpleSolr
+
+I appreciate the effort! GitHub offers excellent tools for collaborating
+on projects, and the basic fork/branch/pull request style is just fine.
+
+To get started, also no surprises:
+
+1. gem install bundler (if you haven't already)
+2. bundle
+3. cp spec/db/database.yml.example spec/db/database.yml
+4. rake
diff --git a/README.rdoc b/README.rdoc
@@ -157,4 +157,9 @@ The response from Solr will look something like this:
   </response>
 
 This response will be translated into a hash by httparty. Take a look at your
-webserver config/response headers if that does not happen.
+webserver config/response headers if that does not happen.
+
+
+== Helping out
+
+Interested in working on SimpleSolr? Please see DEVELOPMENT.rdoc.