Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 66 lines (41 sloc) 1.59 kB
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
1 Sinatra Website / Documentation
2 ===============================
3
4 This repo contains the Sinatra website and documentation sources published
b510e64 @cypher Correctly linkify URLs in README
cypher authored
5 at [http://sinatra.github.com/](http://sinatra.github.com/).
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
6
7 Working Locally
8 ---------------
9
10 Grab the sources from github:
11
d114da1 @djanowski Remove trails of reload option.
djanowski authored
12 $ git clone git://github.com/sinatra/sinatra.github.com.git
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
13 $ cd sinatra.github.com
14
7fe6eb8 @dylanegan Add rdoc as a base dependency.
dylanegan authored
15 Install dependencies:
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
16
17 $ gem install jekyll
488c41b @blairc add a 'l' to 'gem instal' for consistency
blairc authored
18 $ gem install rdoc -v 2.3.0
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
19
20 Run the test server:
21
22 $ rake server
23
24 Changes are immediately available at:
25
6614b04 @rtomayko smackaho.st
rtomayko authored
26 http://sinatrarb.smackaho.st:4000/
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
27
0065667 @dylanegan Can't push to public. Contributing section instead.
dylanegan authored
28 Contributing
29 ------------
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
30
8422c43 @cypher Nicer text for Contributing section in README.md
cypher authored
31 [See GitHub's "Forking a project" for more information](https://github.com/guides/fork-a-project-and-submit-your-modifications "Forking a project").
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
32
33 Creating Blog Posts
34 -------------------
35
36 Blog posts are stored under the `_posts` directory. To create a new blog post
37 and open your `$EDITOR`, use:
38
39 thor blog:new 'Blog Post Title'
40
41 This requires Thor:
42
43 $ gem install thor
44
45 Prebuilt Files
46 --------------
47
645d686 @dylanegan Dependencies for prebuilt files need to be specific for mislav-hanna.
dylanegan authored
48 You will need thor, rdoc, haml and mislav's hanna gem to rebuild static files
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
49 and the API docs:
50
645d686 @dylanegan Dependencies for prebuilt files need to be specific for mislav-hanna.
dylanegan authored
51 $ gem install thor
52 $ gem install rdoc -v 2.3.0
53 $ gem install haml -v 2.0.4
9c27513 @rtomayko Thor is a sucky build tool; use Rake instead
rtomayko authored
54 $ gem install mislav-hanna --source=http://gems.github.com/
55
56 The prebuilt file sources are maintained under the sinatra and sinatra-book
57 projects. To pull in the latest versions and build them:
58
59 rake pull build
60
61 The generated files under the "_includes" and "api" directories need to be
62 committed after building. To regenerate and add those files to your index
63 for the next commit:
64
65 rake regen
Something went wrong with that request. Please try again.