Skip to content

Commit

Permalink
Small changes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
judofyr committed Nov 2, 2009
1 parent 72793c1 commit 48e9ed4
Showing 1 changed file with 28 additions and 23 deletions.
51 changes: 28 additions & 23 deletions README
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== Camping, a Microframework
= Camping, a Microframework

Camping is a web framework which consistently stays at less than 3kb of code.
Camping is a web framework which consistently stays at less than 4kB of code.
You can probably view the complete source code on a single page. But, you
know, it's so small that, if you think about it, what can it really do?

Expand Down Expand Up @@ -44,7 +44,7 @@ A skeletal Camping blog could look like this:
end

def index
for post in @posts
@posts.each do |post|
h1 post.title
end
end
Expand All @@ -56,34 +56,39 @@ 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>
gem install camping

Or for the bleeding edge:
Even better, install the Camping Omnibus, a full package of recommened libs:

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

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>
If not, you should be aware of that Camping itself only depends on
Rack[http://rack.rubyforge.org], and if your going to use the views you also
need to install +markaby+, and if you're going to use the database you need
+activerecord+ as well.

gem install markaby
gem install activerecord

== Learning

* Start by reading the documentation in {the Camping module}[link:classes/Camping.html],
it should get you started pretty quick.
* {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
share your own discoveries; the more, the better!
* Still wondering? Subscribe to {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list],
the place where it's all happening! Don't worry, though, the volume is just
as micro as Camping itself.

First of all, you should read {the first chapters}[link:book/01_introduction.html]
of The Camping Book. It should hopefully get you started pretty quick. While
you're doing that, you should be aware of the _reference_ which contains
documentation for all the different parts of Camping.

{The wiki}[http://wiki.github.com/camping/camping] is the place for all tiny,
useful tricks that we've collected over the years. Don't be afraid to share
your own discoveries; the more, the better!

And if there's anything you're wondering about, don't be shy, but rather
subscribe to {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list]
and ask there. We also have an IRC channel over at Freenode, so if you feel
like chatting with us, you should join {#camping @ irc.freenode.net}[http://java.freenode.net/?channel=camping].

== Authors

Camping was originally started by {why the lucky stiff}[http://en.wikipedia.org/wiki/Why_the_lucky_stiff],
Camping was originally crafted 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
patch, it will be applied. Everything is managed through {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list],
so just subscribe and you can instantly take a part in shaping Camping.

0 comments on commit 48e9ed4

Please sign in to comment.