Permalink
Browse files

update readme

  • Loading branch information...
1 parent 6b92575 commit d42c35d1bb8c0480ef734948d0ca723b9e943e68 @qrush qrush committed May 18, 2011
Showing with 20 additions and 3 deletions.
  1. +20 −3 README.md
View
23 README.md
@@ -10,8 +10,11 @@ Goals
* Help out those new to RubyGems get started and get things done
* Make it easy to contribute more guides
-Todo
-====
+Want to help?
+=============
+
+If a guide is empty, start filling it out! Or, make a new one! Pull requests
+are gladly accepted!
* Port content from docs.rubygems.org
* Port content from rubygems.org/pages/docs
@@ -24,10 +27,24 @@ Setup
Make sure you have jekyll installed (`gem install jekyll`), and run:
- $ jekyll --server
+ $ jekyll --server
The pages will be available at http://localhost:4000/
+Every guide except for the Command and Specification Reference is just a
+straight up markdown page, so just go edit it!
+
+For the Command Guide (`command-reference.md`), edit `command-reference.erb`
+and run:
+
+ $ rake command_guide
+
+For the Specification Guide, the documentation comes directly from the
+`Gem::Specification` class in RubyGems. Edit it, set your `RUBYGEMS_DIR` to
+where your code directory is, and run:
+
+ $ RUBYGEMS_DIR=~/Dev/ruby/rubygems rake spec_guide --trace
+
Thanks
======

0 comments on commit d42c35d

Please sign in to comment.