You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
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 install ruby 1.9.3 with
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.
5
4
6
-
$ rvm install ruby 1.9.3
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>.
7
6
8
-
Then you need to install bundler:
7
+
#Table of Contents
9
8
10
-
$ gem install bundler
9
+
-[Setting up the development environment](#setting-up)
10
+
-[Working with the site](#working-with-the-site)
11
+
-[Build and deploy](#building-and-deploying)
12
+
13
+
#Setting up
14
+
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
+
17
+
$ rvm list
18
+
19
+
rvm rubies
20
+
21
+
=* ruby-1.9.3-p362 [ x86_64 ]
11
22
12
-
Next, install ruby dependencies:
23
+
# => - current
24
+
# =* - current & default
25
+
# * - default
26
+
27
+
The above means RVM installed correct Ruby version 1.9.3
28
+
29
+
$ ruby -v
30
+
ruby 1.9.3 p362
31
+
$ gem -v
32
+
1.8.24
33
+
34
+
The above means the correct Ruby- and Rubygems-commands work.
35
+
36
+
If you need to install Ruby 1.9.3 separately, do:
37
+
38
+
$ rvm install ruby 1.9.3
39
+
40
+
Next, you need to install[Bundler](http://gembundler.com/) and check it works:
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
+
55
+
$ sudo aptitude install zlib1g-dev
56
+
$ rvm reinstall ruby 1.9.3
57
+
$ gem install bundler
58
+
59
+
Next, clone the repository, switch to <tt>source</tt> branch, and install Ruby dependencies with bundler:
After Docutils, install Pygments. As of now (Jan 2013), Robot Framework lexer is still not part of the official release of Pygments. Therefore, you need to install Pygments from sources:
Robot Framework lexer is part of the official release of Pygments since version 1.6. If pip gives you an earlier version, you need to install the lexer yourself:
23
75
24
-
Last but not least, clone site from the url from the Github. Checkout <tt>source</tt> branch from remote with:
76
+
$ sudo pip install robotframeworklexer
25
77
26
-
$ git checkout -b source origin/source
78
+
You should now be able to start working with the site. Run the following command and then open browser and go tohttp://localhost:4000 to see the site. You can quit the server with <tt>Ctrl-c</tt>
27
79
28
-
##Working with the site
80
+
$ jekyll --server
81
+
82
+
#Working with the site
29
83
30
84
<b>!IMPORTANT!</b>
31
85
The site that is available in the web is in the <tt>master</tt> branch. <b>Do not</b> modify the master branch! Rather, do your changes in <tt>source</tt> branch and deploy with rake (see below).
32
86
33
-
The site uses[Jekyll](https://github.com/mojombo/jekyll) to build the site. Jekyll should be installed with bundler as part ofruby dependencies (described in the last section).
87
+
The site uses[Jekyll](https://github.com/mojombo/jekyll) to build the site. Jekyll should be installed with bundler as part ofRuby dependencies (described in the last section).
34
88
35
89
To run the site with local development server, run:
36
90
@@ -46,11 +100,13 @@ The preferable way to run the site during development is however:
46
100
47
101
$ jekyll --server --auto
48
102
49
-
This will automatically update the files when you save them, so you just need to hit refresh in your browser to see results.
103
+
This will automatically update the files when you save them after editing, so you just need to hit refresh in your browser to see updated site.
104
+
105
+
#Building and deploying
50
106
51
-
##Building anddeploying
107
+
<b>Important to note:</b> quit all <tt>jekyll</tt>s that are running as server beforedeploying!
52
108
53
-
The website uses[Rake](http://rake.rubyforge.org/) to build and deploy the website.Toosee availablecommands, run:
109
+
The website uses[Rake](http://rake.rubyforge.org/) to build and deploy the website.This should have been installed as part of Ruby dependencies (seeInstallation). To seeavailablerake tasks, run:
54
110
55
111
/path/to/robotframework.github.com $ rake -T
56
112
@@ -63,9 +119,11 @@ To deploy the site online, you need to first commit all your changes. After comm
63
119
/path/to/robotframework.github.com $ rake deploy
64
120
65
121
The deployment process does the following things:
66
-
- Checks that you have committed everything; the working tree needs to be clean
67
122
- Builds the project using the build rake task
123
+
- Checks that you have committed everything, makes you commit if not.
68
124
- Copies the builded files to your OS's temp folder
69
125
- Switches to master branch, copies files over from temp folder
70
-
- Commits the changes and pushes to master. Notice that you still need to push the source branch to remote.
71
-
- Switches back to source branch
126
+
- Commits the changes and pushes to remote <tt>master</tt>.
127
+
- Switches back to <tt>source</tt> branch
128
+
- Notice that you still need to push the <tt>source</tt> branch yourself to remote with: