|
1 | 1 | # robotframework.github.com |
2 | 2 |
|
3 | | -This repository hosts Robot Framework's public website available at [robotframework.github.com](http://robotframework.github.com). It uses [Ruby](http://www.ruby-lang.org/) programming language and it's tools [Jekyll](https://github.com/mojombo/jekyll) (a static website generator) and [jekyll-rst](https://github.com/xdissent/jekyll-rst) (a [reStructuredText](https://github.com/xdissent/jekyll-rst)-plugin), among others. |
| 3 | +This repository hosts Robot Framework's public website available at [robotframework.github.com](http://robotframework.github.com). It uses [Ruby](http://www.ruby-lang.org/) based tools [Jekyll](https://github.com/mojombo/jekyll) (a static website generator) and [jekyll-rst](https://github.com/xdissent/jekyll-rst) (a [reStructuredText](https://github.com/xdissent/jekyll-rst) plugin), among others. |
4 | 4 |
|
5 | | -<b>Important to note:</b> As this site is hosted in Github Pages, the <tt>master</tt> branch hosts the files. The <tt>source</tt> branch is where the development happens and from where site is deployed to <tt>master</tt> branch. You should not therefore change any files in <tt>master</tt> branch -- rather, do your work in <tt>source</tt> branch and deploy to <tt>master</tt>. |
| 5 | +<b>Important to note:</b> As this site is hosted in GitHub Pages, the <tt>master</tt> branch hosts the files. The <tt>source</tt> branch is where the development happens and from where site is deployed to the <tt>master</tt> branch. You <b>should not</b> therefore change any files in the <tt>master</tt> branch directly. Rather, do your work in the <tt>source</tt> branch and deploy to the <tt>master</tt>. |
6 | 6 |
|
7 | 7 | # Table of Contents |
8 | 8 |
|
9 | | -- [Setting up the development environment](#setting-up) |
| 9 | +- [Setting up the development environment](#setting-up-the-development-environment) |
10 | 10 | - [Working with the site](#working-with-the-site) |
11 | 11 | - [Build and deploy](#building-and-deploying) |
12 | 12 |
|
13 | | -# Setting up |
| 13 | +# Setting up the development environment |
14 | 14 |
|
15 | 15 | The preferable way to install Ruby is via [RVM](https://rvm.io/rvm/install/). Follow install instructions on the linked page to get RVM, then make sure you have Ruby 1.9.3 and Rubygems installed correctly: |
16 | 16 |
|
@@ -53,7 +53,7 @@ On Linux, you might get the following exception: |
53 | 53 | This means you are missing zlib or zlib-Ruby -bindings. Install them from aptitude and reinstall Ruby with RVM. (The following works on Linux Mint -- see [Stackoverflow thread](http://stackoverflow.com/questions/9727908/cannot-load-such-file-zlib-even-after-using-rvm-pkg-install-zlib) for more details) |
54 | 54 |
|
55 | 55 | $ sudo aptitude install zlib1g-dev |
56 | | - $ rvm reinstall ruby 1.9.3 |
| 56 | + $ rvm reinstall 1.9.3 |
57 | 57 | $ gem install bundler |
58 | 58 |
|
59 | 59 | Next, clone the repository, switch to <tt>source</tt> branch, and install Ruby dependencies with bundler: |
|
0 commit comments