Skip to content

Commit 7ebd027

Browse files
committed
Updated the Developer's Guide to better reflect the current workflow.
1 parent fffd98e commit 7ebd027

File tree

1 file changed

+24
-30
lines changed

1 file changed

+24
-30
lines changed

developers-guide.md

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ _Please help out by updating this page_
99

1010
### Operating System
1111

12-
It works on Mac OSX. Probably works without any changes or issues on linux. A masochist could probably get it working on Windows.
12+
It works on Mac OSX. Probably works without any changes or issues on Linux.
13+
A masochist could probably get it working on Windows.
1314

1415
## Installation
1516

@@ -19,54 +20,47 @@ It works on Mac OSX. Probably works without any changes or issues on linux. A ma
1920
git clone git://github.com/coffeescript-cookbook/coffeescript-cookbook.github.com.git
2021
{% endhighlight %}
2122

22-
### Create a Ruby Gemset
23+
### Ruby environment
2324

24-
Optional, but highly recommended.
25+
You probably want to have [RVM](http://rvm.io/) installed.
2526

26-
{% highlight bash %}
27-
$ rvm gemset create jekyll
28-
$ echo 'rvm gemset use jekyll' >> .rvmrc
29-
{% endhighlight %}
30-
31-
### Install Required Gems
27+
The project includes a `.ruby-version` file locked to
28+
*1.9.3* since that is what Github Pages are currently using.
3229

33-
{% highlight bash %}
34-
gem install jekyll # needed for testing building the site
35-
gem install RedCloth # needed for .md rendering
36-
gem install serve # needed for resolving .html files w/o extension
37-
gem install thin # optional; more efficient webserver than Webrick but not strictly necessary
38-
{% endhighlight %}
30+
There is also a `.ruby-gemset` that is set to *coffeescript-cookbook*
3931

40-
### Install pygments
32+
### Required dependencies
4133

42-
You'll need python installed for this. Macs and most linuces come with it preinstalled.
34+
We are using [Bundler](http://bundler.io/) to install the required Ruby dependencies.
4335

4436
{% highlight bash %}
45-
easy_install pygments # for syntax highlighting
37+
bundle install
4638
{% endhighlight %}
4739

48-
## Building and Viewing the Website
49-
50-
### Run jekyll
40+
#### Install pygments
5141

52-
Open a terminal window, cd into the project folder and run jekyll from the project root.
42+
You'll need python installed for this.
43+
Macs and most Linuces come with it preinstalled.
5344

5445
{% highlight bash %}
55-
jekyll --auto
46+
easy_install pygments # for syntax highlighting
5647
{% endhighlight %}
5748

58-
Leave this window running while you work. Any time you change a file, jekyll will rerender it into the `_site` folder.
59-
60-
### Run serve
49+
## Building and Viewing the Website
6150

62-
Open another terminal window, cd into the project folder, then cd into the `_site` subfolder, and run
51+
Open a terminal window, cd into the project folder and run `foreman start` from the project root.
6352

6453
{% highlight bash %}
65-
serve
54+
foreman start
6655
{% endhighlight %}
6756

68-
This will start a webserver in the `_site` folder. Open a browser and visit `http://localhost:4000/` and you should see the site.
57+
Leave this window running while you work.
58+
Any time you change a file, jekyll will rerender it into the `_site` folder.
59+
60+
Open a browser and visit <http://localhost:4000/> and you should see the site.
6961

7062
## Minutiae and Other Trivialities
7163

72-
jekyll can take a second or two to catch up when you save a file. If you edit a file and don't see the changes in your browser, give it a second or two and try again. You may also see Maruku warnings, but as long as it prints `Successfully generated site` you should be alright.
64+
Jekyll can take a second or two to catch up when you save a file.
65+
If you edit a file and don't see the changes in your browser, give it a second or two and try again.
66+
As long as it prints `Successfully generated site` you should be alright.

0 commit comments

Comments
 (0)