Skip to content

Commit 5d76408

Browse files
committed
Better README
1 parent 7a654cf commit 5d76408

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,18 @@ Next, install Docutils:
1717

1818
$ pip install docutils
1919

20-
Last but not least, 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:
20+
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:
2121

2222
$ pip install hg+http://bitbucket.org/birkenfeld/pygments-main
2323

24+
Last but not least, clone site from the url from the Github. Checkout <tt>source</tt> branch from remote with:
25+
26+
$ git checkout -b source origin/source
27+
2428
## Working with the site
2529

2630
<b>!IMPORTANT!</b>
27-
The site that is available in the web is in the master branch. <b>Do not</b> change the master branch! Instead, do most of the work source branch.
31+
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).
2832

2933
The site uses [Jekyll](https://github.com/mojombo/jekyll) to build the site. Jekyll should be installed with bundler as part of ruby dependencies (described in the last section).
3034

_site/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,18 @@ Next, install Docutils:
1717

1818
$ pip install docutils
1919

20-
Last but not least, 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:
20+
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:
2121

2222
$ pip install hg+http://bitbucket.org/birkenfeld/pygments-main
2323

24+
Last but not least, clone site from the url from the Github. Checkout <tt>source</tt> branch from remote with:
25+
26+
$ git checkout -b source origin/source
27+
2428
## Working with the site
2529

2630
<b>!IMPORTANT!</b>
27-
The site that is available in the web is in the master branch. <b>Do not</b> change the master branch! Instead, do most of the work source branch.
31+
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).
2832

2933
The site uses [Jekyll](https://github.com/mojombo/jekyll) to build the site. Jekyll should be installed with bundler as part of ruby dependencies (described in the last section).
3034

0 commit comments

Comments
 (0)