kotovalexarian-likes-github/sinatra
1
0
Fork 0
mirror of https://github.com/sinatra/sinatra synced 2023-03-27 23:18:01 -04:00
Code Releases Activity

minor formatting tweaks to cypher's README updates

Browse source
This commit is contained in:
Ryan Tomayko 2008-08-31 12:09:10 -07:00
parent b639f0493d
commit 480fbfa7d4
1 changed files with 37 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.rdoc
View file

@ -173,7 +173,8 @@ Templates may be defined at the end of the source file:
@@ index @@ index
%div.title Hello world!!!!! %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 template :layout do
"X\n=yield\nX" "X\n=yield\nX"
@ -460,20 +461,20 @@ Options are:
-e # set the environment (default is development) -e # set the environment (default is development)
-x # turn on the mutex lock (default is off) -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 Besides Ruby itself, you only need a text editor, preferably one that supports
syntax hilighting. VIM and Emacs are a fine choice on any platform, but feel free to Ruby syntax hilighting. VIM and Emacs are a fine choice on any platform, but
use whatever you're familiar with. feel free to use whatever you're familiar with.
Sinatra uses the Git source code management system. If you're unfamiliar with Git, Sinatra uses the Git source code management system. If you're unfamiliar with
you can find more information and tutorials on http://git.or.cz/ as well as http://git-scm.com/. Git, you can find more information and tutorials on http://git.or.cz/ as well
Scott Chacon created a great series of introductory screencasts about Git, as http://git-scm.com/. Scott Chacon created a great series of introductory
which you can find here: http://www.gitcasts.com/ 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 cd where/you/keep/your/projects
git clone git://github.com/bmizerany/sinatra.git git clone git://github.com/bmizerany/sinatra.git
@ -482,13 +483,13 @@ which you can find here: http://www.gitcasts.com/
cd path/to/your_project cd path/to/your_project
ln -s ../sinatra/ ln -s ../sinatra/
== Updating your existing Sinatra clone === Updating Your Existing Sinatra Clone
cd where/you/keep/sinatra cd where/you/keep/sinatra
git pull git pull
git submodule update --init 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: 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 "I'm running on Version " + Sinatra::VERSION
end end
== Contributing a patch === Contributing a Patch
There are several ways to do this. Probably the easiest (and preferred) way is to There are several ways to do this. Probably the easiest (and preferred) way is
fork Sinatra on GitHub (http://github.com/bmizerany/sinatra), push your changes to fork Sinatra on GitHub (http://github.com/bmizerany/sinatra), push your
to your Sinatra repo, and then send Blake Mizerany (bmizerany on GitHub) a pull request. 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 You can also create a patch file and attach it to a feature request or bug fix
tracker (see below) or send it to the mailing list (see Community section). 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/ http://sinatra.lighthouseapp.com/
= Community == Community
== Mailing List === Mailing List
http://groups.google.com/group/sinatrarb http://groups.google.com/group/sinatrarb
If you have a problem or question, please make sure to include all the relevant If you have a problem or question, please make sure to include all the
information in your mail, like the Sinatra version you're using, what version of Ruby relevant information in your mail, like the Sinatra version you're using, what
you have, and so on. 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 There's usually someone online at any given time, but we cannot pay attention
channel all the time, so please stick around for a while after asking a question. to the channel all the time, so please stick around for a while after asking a
question.