Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 56 lines (37 sloc) 1.578 kb
591ad56b » qrush
2011-04-27 fill out readme
1 RubyGems Guides
2 ===============
3
4 An effort to provide awesome documentation for the RubyGems ecosystem.
5
6 Goals
7 =====
8
9 * Be the definitive place for RubyGems knowledge
10 * Help out those new to RubyGems get started and get things done
11 * Make it easy to contribute more guides
12
d42c35d1 » qrush
2011-05-17 update readme
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!
591ad56b » qrush
2011-04-27 fill out readme
18
19 * Port content from docs.rubygems.org
20 * Port content from rubygems.org/pages/docs
21 * Port content from help.rubygems.org knowledge base
22 * Find lots of StackOverflow/ruby-talk questions and get their common answers in here
23 * Fill out more guides!
24
25 Setup
26 =====
27
28 Make sure you have jekyll installed (`gem install jekyll`), and run:
160b53c1 » qrush
2011-04-27 get this guides party started
29
d42c35d1 » qrush
2011-05-17 update readme
30 $ jekyll --server
160b53c1 » qrush
2011-04-27 get this guides party started
31
32 The pages will be available at http://localhost:4000/
7b3700f6 » qrush
2011-04-27 add some thanks and licenses
33
d42c35d1 » qrush
2011-05-17 update readme
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
7b3700f6 » qrush
2011-04-27 add some thanks and licenses
48 Thanks
49 ======
50
327d01f6 » vijaydev
2011-05-19 fixes thoughtbot url
51 Huge thanks to [thoughtbot](http://thoughtbot.com) whose [handbook](http://handbook.thoughtbot.com) this is based off of.
7b3700f6 » qrush
2011-04-27 add some thanks and licenses
52
53 Legal
54 =====
55
56 The actual content of the articles is licensed under Creative Commons. The code that this project consists of is licensed under MIT.
Something went wrong with that request. Please try again.