Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

minor formatting tweaks to cypher's README updates

  • Loading branch information...
commit 480fbfa7d4dc2ccf5930d836217f6944d3ce1e12 1 parent b639f04
@rtomayko rtomayko authored
Showing with 37 additions and 32 deletions.
  1. +37 −32 README.rdoc
View
69 README.rdoc
@@ -173,7 +173,8 @@ Templates may be defined at the end of the source file:
@@ index
%div.title Hello world!!!!!
-It's also possible to define named templates using the
+It's also possible to define named templates using the top-level template
+method:
template :layout do
"X\n=yield\nX"
@@ -460,20 +461,20 @@ Options are:
-e # set the environment (default is development)
-x # turn on the mutex lock (default is off)
-== Contribute
+== Contributing
-== Tools
+=== Tools
-Besides Ruby itself, you only need a text editor, preferably one that supports Ruby
-syntax hilighting. VIM and Emacs are a fine choice on any platform, but feel free to
-use whatever you're familiar with.
+Besides Ruby itself, you only need a text editor, preferably one that supports
+Ruby syntax hilighting. VIM and Emacs are a fine choice on any platform, but
+feel free to use whatever you're familiar with.
-Sinatra uses the Git source code management system. If you're unfamiliar with Git,
-you can find more information and tutorials on http://git.or.cz/ as well as http://git-scm.com/.
-Scott Chacon created a great series of introductory screencasts about Git,
-which you can find here: http://www.gitcasts.com/
+Sinatra uses the Git source code management system. If you're unfamiliar with
+Git, you can find more information and tutorials on http://git.or.cz/ as well
+as http://git-scm.com/. Scott Chacon created a great series of introductory
+screencasts about Git, which you can find here: http://www.gitcasts.com/
-== First Time: Cloning the sinatra repo
+=== First Time: Cloning The Sinatra Repo
cd where/you/keep/your/projects
git clone git://github.com/bmizerany/sinatra.git
@@ -481,14 +482,14 @@ which you can find here: http://www.gitcasts.com/
git submodule update --init
cd path/to/your_project
ln -s ../sinatra/
-
-== Updating your existing Sinatra clone
-
+
+=== Updating Your Existing Sinatra Clone
+
cd where/you/keep/sinatra
git pull
git submodule update --init
-
-== Using edge Sinatra in your app
+
+=== Using Edge Sinatra in Your App
at the top of your sinatra_app.rb file:
@@ -499,32 +500,36 @@ at the top of your sinatra_app.rb file:
"I'm running on Version " + Sinatra::VERSION
end
-== Contributing a patch
+=== Contributing a Patch
-There are several ways to do this. Probably the easiest (and preferred) way is to
-fork Sinatra on GitHub (http://github.com/bmizerany/sinatra), push your changes
-to your Sinatra repo, and then send Blake Mizerany (bmizerany on GitHub) a pull request.
+There are several ways to do this. Probably the easiest (and preferred) way is
+to fork Sinatra on GitHub (http://github.com/bmizerany/sinatra), push your
+changes to your Sinatra repo, and then send Blake Mizerany (bmizerany on
+GitHub) a pull request.
-You can also create a patch file and attach it to a feature request or bug fix on the issue
-tracker (see below) or send it to the mailing list (see Community section).
+You can also create a patch file and attach it to a feature request or bug fix
+on the issue tracker (see below) or send it to the mailing list (see Community
+section).
-== Issue tracking & feature requests
+=== Issue Tracking and Feature Requests
http://sinatra.lighthouseapp.com/
-= Community
+== Community
-== Mailing List
+=== Mailing List
http://groups.google.com/group/sinatrarb
-If you have a problem or question, please make sure to include all the relevant
-information in your mail, like the Sinatra version you're using, what version of Ruby
-you have, and so on.
+If you have a problem or question, please make sure to include all the
+relevant information in your mail, like the Sinatra version you're using, what
+version of Ruby you have, and so on.
-== IRC Channel
+=== IRC Channel
-You can find us on the Freenode network in the channel #sinatra (irc://chat.freenode.net/#sinatra)
+You can find us on the Freenode network in the channel #sinatra
+(irc://chat.freenode.net/#sinatra)
-There's usually someone online at any given time, but we cannot pay attention to the
-channel all the time, so please stick around for a while after asking a question.
+There's usually someone online at any given time, but we cannot pay attention
+to the channel all the time, so please stick around for a while after asking a
+question.
Please sign in to comment.
Something went wrong with that request. Please try again.