Mercurial > hg > sv-dependency-builds
comparison src/capnproto-git-20161025/doc/README.md @ 133:1ac99bfc383d
Add Cap'n Proto source
author | Chris Cannam <cannam@all-day-breakfast.com> |
---|---|
date | Tue, 25 Oct 2016 11:17:01 +0100 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
132:42a73082be24 | 133:1ac99bfc383d |
---|---|
1 # Cap'n Proto Documentation | |
2 | |
3 This directory contains the "source code" for the Cap'n Proto web site. | |
4 | |
5 The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby. | |
6 Start by installing ruby1.9.1-dev. On Debian-based operating systems: | |
7 | |
8 sudo apt-get install ruby1.9.1-dev | |
9 | |
10 Then install Jekyll: | |
11 | |
12 sudo gem install jekyll | |
13 | |
14 Now install Pygments and SetupTools to be able to install the CapnProto lexer. | |
15 On Debian based operating systems: | |
16 | |
17 sudo apt-get install python-pygments python-setuptools | |
18 | |
19 Next, install the custom Pygments syntax highlighter: | |
20 | |
21 cd _plugins | |
22 sudo python capnp_lexer.py install | |
23 cd .. | |
24 | |
25 Now you can launch a local server: | |
26 | |
27 jekyll serve highlighter --watch | |
28 | |
29 Edit, test, commit. | |
30 | |
31 If you have permission, after you've pushed your changes back to github, you can make your changes live by running: | |
32 | |
33 ./push-site.sh | |
34 | |
35 Otherwise, send a pull request and let someone else actually push the new site. |