Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

update readme

  • Loading branch information...
commit d42c35d1bb8c0480ef734948d0ca723b9e943e68 1 parent 6b92575
Nick Quaranto qrush authored

Showing 1 changed file with 20 additions and 3 deletions. Show diff stats Hide diff stats

  1. +20 3 README.md
23 README.md
Source Rendered
@@ -10,8 +10,11 @@ Goals
10 10 * Help out those new to RubyGems get started and get things done
11 11 * Make it easy to contribute more guides
12 12
13   -Todo
14   -====
  13 +Want to help?
  14 +=============
  15 +
  16 +If a guide is empty, start filling it out! Or, make a new one! Pull requests
  17 +are gladly accepted!
15 18
16 19 * Port content from docs.rubygems.org
17 20 * Port content from rubygems.org/pages/docs
@@ -24,10 +27,24 @@ Setup
24 27
25 28 Make sure you have jekyll installed (`gem install jekyll`), and run:
26 29
27   - $ jekyll --server
  30 + $ jekyll --server
28 31
29 32 The pages will be available at http://localhost:4000/
30 33
  34 +Every guide except for the Command and Specification Reference is just a
  35 +straight up markdown page, so just go edit it!
  36 +
  37 +For the Command Guide (`command-reference.md`), edit `command-reference.erb`
  38 +and run:
  39 +
  40 + $ rake command_guide
  41 +
  42 +For the Specification Guide, the documentation comes directly from the
  43 +`Gem::Specification` class in RubyGems. Edit it, set your `RUBYGEMS_DIR` to
  44 +where your code directory is, and run:
  45 +
  46 + $ RUBYGEMS_DIR=~/Dev/ruby/rubygems rake spec_guide --trace
  47 +
31 48 Thanks
32 49 ======
33 50

0 comments on commit d42c35d

Please sign in to comment.
Something went wrong with that request. Please try again.