Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 83 lines (53 sloc) 2.998 kb
9c25adb @zzak s/book-contrib/recipes
zzak authored
1 Sinatra Recipes
2 ---------------
5d5467a @zzak init
zzak authored
3
9c25adb @zzak s/book-contrib/recipes
zzak authored
4 Community contributed recipes and techniques for the [Sinatra Web
5 Framework][sinatra].
5d5467a @zzak init
zzak authored
6
7 ## Why yet another doc project?
8
9 Quite simply, the Sinatra README and Book have become long in the tooth.
10
11 This project is to extract any redundant and overlap between the two sources,
12 and create a home for user contributed recipes and documentation to take form.
13
14 ## How can I help?
15
9c25adb @zzak s/book-contrib/recipes
zzak authored
16 Got a recipe or tutorial for [Sinatra][sinatra]? Awesome, this is
5d5467a @zzak init
zzak authored
17 the first place you should go if you're looking to contribute.
18
19 Once you have [forked the project][github-forking] send a [pull
20 request][github-pull-requests], just be sure to follow the [styling
21 guidelines][style-guidelines].
22
23 You can also get a hold of us on [irc][irc] or the [mailinglist][mailinglist].
24
b184e76 @zzak note about issue tracker
zzak authored
25 Don't have any ideas? Check out the existing [issue tracker][issues] for
26 recipes that have been requested or are in progress.
27
5d5467a @zzak init
zzak authored
28 ## Here's the run down
29
30 To get started you should clone the repository from github:
31
9c25adb @zzak s/book-contrib/recipes
zzak authored
32 git clone git://github.com/sinatra/sinatra-recipes.git
5d5467a @zzak init
zzak authored
33
9c25adb @zzak s/book-contrib/recipes
zzak authored
34 Now once you `cd` into `sinatra-recipes` you should see a few things.
5d5467a @zzak init
zzak authored
35
36 First you should take note of the application files:
37
38 app.rb # a tiny application for displaying the contributed recipes
39 config.ru # rackup file for deploying to heroku
40 Gemfile # dependencies file for bundler to run the app
41
42 If you want to run the application yourself first you need the `bundler` gem.
43
44 gem install bundler
45
c1dcbc9 @burningTyger retry to fix 1.9.2 and rbx
burningTyger authored
46 If you are on Rubinius make sure that you have the latest bundler version
47 installed. Versions prior to 1.0.10 won't work.
48
5d5467a @zzak init
zzak authored
49 # then install the application dependencies
50 bundle install
51
52 Once that is complete, you should only need to run `rackup` in the application
53 root and visit: [localhost:9292](http://localhost:9292)
54
55 Since the application just maps the flat files, you can browse either the
56 source or the web app to view recipes.
57
58 If you check out the source you will see a few folders listed, in each folder
59 there is a `README.md` that will briefly explain the topic. This can also be
60 view by going to `/p/:topic` where `topic` is the folder you wish to view.
61
62 In each folder there should be a number of recipes pertaining to each topic.
63
35fb8d4 @zzak on translations
zzak authored
64 ## On translations
65
1c3613e @zzak wording
zzak authored
66 Currently we're not supporting translations in the main repository.
35fb8d4 @zzak on translations
zzak authored
67
68 However, if you'd like to maintain a fork for translating the docs then feel
69 free to do so, and add your fork to the [list of translations in the
70 wiki][translations].
71
5d5467a @zzak init
zzak authored
72 [sinatra]: http://www.sinatrarb.com/
73 [sinatra-book]: http://github.com/sinatra/sinatra-book
9c25adb @zzak s/book-contrib/recipes
zzak authored
74 [issues]: https://github.com/sinatra/sinatra-recipes/issues
75 [style-guidelines]: http://github.com/sinatra/sinatra-recipes/wiki/Style-Guidelines
76 [translations]: http://github.com/sinatra/sinatra-recipes/wiki/Translations
5d5467a @zzak init
zzak authored
77 [irc]: irc://irc.freenode.net/#sinatra
78 [mailinglist]: http://groups.google.com/group/sinatrarb
79 [github-forking]: http://help.github.com/forking/
80 [github-pull-requests]: http://help.github.com/pull-requests/
81
82
Something went wrong with that request. Please try again.