Skip to content

Commit

Permalink
Some minor documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
judofyr committed Mar 7, 2009
1 parent 5adca53 commit 7b914ab
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
27 changes: 16 additions & 11 deletions README
Expand Up @@ -52,33 +52,38 @@ A skeletal Camping blog could look like this:


== Installation == Installation


Interested yet? Luckily it's quite easy to install Camping. We'll be using a tool called RubyGems, so if you don't have that installed yet, go grab it! Once that's sorted out, open up a Terminal or Command Line and enter: Interested yet? Luckily it's quite easy to install Camping. We'll be using
a tool called RubyGems, so if you don't have that installed yet, go grab it!
Once that's sorted out, open up a Terminal or Command Line and enter:


* <tt>gem install camping</tt> * <tt>gem install camping</tt>


Or for the bleeding edge: Or for the bleeding edge:


* <tt>gem install camping --source http://gems.judofyr.net</tt> * <tt>gem install camping --source http://gems.judofyr.net</tt>


This will download everything you need and get you all set up. If you're installing camping manually, you'll need to make sure you have 'rack' installed as well, the interface Camping uses to talk to your web server. You'll also need 'markaby' for the views, and 'activerecord' if you're going to be using databases. Camping itself only depends on Rack[http://rack.rubyforge.org] and using the
command above will only install Camping and Rack. However, if you intend to
use the views you also need to install +markaby+, and if you're going to use
the database you need +activerecord+ as well:

* <tt>gem install markaby</tt>
* <tt>gem install activerecord</tt>


== Learning == Learning


* Start by reading the documentation in {the Camping module}[link:classes/Camping.html] * Start by reading the documentation in {the Camping module}[link:classes/Camping.html],
- it should get you started pretty quick. it should get you started pretty quick.
* {The wiki}[http://wiki.github.com/why/camping] is the place for all tiny, * {The wiki}[http://wiki.github.com/why/camping] is the place for all tiny,
useful tricks that we've collected over the years. Don't be afraid to useful tricks that we've collected over the years. Don't be afraid to
share your own discoveries; the more, the better! share your own discoveries; the more, the better!
* Still wondering? Subscribe to {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list]. * Still wondering? Subscribe to {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list],
This is where it's all happening! Don't worry, though, the volume is just the place where it's all happening! Don't worry, though, the volume is just
as micro as Camping itself. as micro as Camping itself.


== Authors == Authors


Camping was originally started by{why the lucky stiff}[http://en.wikipedia.org/wiki/Why_the_lucky_stiff], Camping was originally started by {why the lucky stiff}[http://en.wikipedia.org/wiki/Why_the_lucky_stiff],
but is now maintained by the _community_. This simply means that if we like your but is now maintained by the _community_. This simply means that if we like your
patch, it will be applied. Everything is managed through {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list], patch, it will be applied. Everything is managed through {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list],
so just subscribe and you'll become a contributor too. Remember: writing the so just subscribe and you can instantly take a part in shaping Camping.
code is just half the job, without some serious thinking from you we won't get
any further.

10 changes: 5 additions & 5 deletions lib/camping-unabridged.rb
Expand Up @@ -557,8 +557,8 @@ def service(*a)
# === Resource # === Resource
# #
# A _resource_ in HTTP is simply a name of a _thing_ - it's a noun. Just like # A _resource_ in HTTP is simply a name of a _thing_ - it's a noun. Just like
# "home", "blog post" and "comment" are nouns in our world, are "/", # "home", "blog post" and "comment" are nouns in our world, are +/+,
# "/post/123" and "/post/123/comment/456" resources in HTTP. # +/post/123+ and +/post/123/comment/456+ resources in HTTP.
# #
# Nouns are well and good, but just like you can't build a sentence with # Nouns are well and good, but just like you can't build a sentence with
# only nouns, you can't build a request with only a resource. We need verbs! # only nouns, you can't build a request with only a resource. We need verbs!
Expand Down Expand Up @@ -692,7 +692,7 @@ def service(*a)
# #
# Very often, you will name your controllers identical to it's route. If # Very often, you will name your controllers identical to it's route. If
# you leave out the route and just define the controller as a class # you leave out the route and just define the controller as a class
# (+class Posts+), Camping will automatically build the route using some magic: # (<tt>class Posts</tt>), Camping will automatically build the route using some magic:
# #
# First it will split the controller name up by words. For instance # First it will split the controller name up by words. For instance
# +VeryNiftyRoute+ will be split up into +Very+, +Nifty+ and +Route+. # +VeryNiftyRoute+ will be split up into +Very+, +Nifty+ and +Route+.
Expand All @@ -701,7 +701,7 @@ def service(*a)
# #
# * Index turns into / # * Index turns into /
# * X turns into ([^/]+) # * X turns into ([^/]+)
# * N turns into (\d+) # * N turns into (\\\d+)
# * Everything else turns into lowercase # * Everything else turns into lowercase
# #
# Finally it puts a slash between the parts. # Finally it puts a slash between the parts.
Expand Down Expand Up @@ -896,7 +896,7 @@ def method_missing(m, c, *a)
# end # end
# end # end
# #
# In your controllers you just call +render :template_name+ which will # In your controllers you just call <tt>render :template_name</tt> which will
# invoke the template. The views and controllers will share instance # invoke the template. The views and controllers will share instance
# variables (as you can see above). # variables (as you can see above).
# #
Expand Down

0 comments on commit 7b914ab

Please sign in to comment.