Mercurial > hg > sv-dependency-builds
diff src/capnproto-git-20161025/doc/README.md @ 48:9530b331f8c1
Add Cap'n Proto source
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Tue, 25 Oct 2016 11:17:01 +0100 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/capnproto-git-20161025/doc/README.md Tue Oct 25 11:17:01 2016 +0100 @@ -0,0 +1,35 @@ +# Cap'n Proto Documentation + +This directory contains the "source code" for the Cap'n Proto web site. + +The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby. +Start by installing ruby1.9.1-dev. On Debian-based operating systems: + + sudo apt-get install ruby1.9.1-dev + +Then install Jekyll: + + sudo gem install jekyll + +Now install Pygments and SetupTools to be able to install the CapnProto lexer. +On Debian based operating systems: + + sudo apt-get install python-pygments python-setuptools + +Next, install the custom Pygments syntax highlighter: + + cd _plugins + sudo python capnp_lexer.py install + cd .. + +Now you can launch a local server: + + jekyll serve highlighter --watch + +Edit, test, commit. + +If you have permission, after you've pushed your changes back to github, you can make your changes live by running: + + ./push-site.sh + +Otherwise, send a pull request and let someone else actually push the new site.