annotate 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
rev   line source
cannam@133 1 # Cap'n Proto Documentation
cannam@133 2
cannam@133 3 This directory contains the "source code" for the Cap'n Proto web site.
cannam@133 4
cannam@133 5 The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby.
cannam@133 6 Start by installing ruby1.9.1-dev. On Debian-based operating systems:
cannam@133 7
cannam@133 8 sudo apt-get install ruby1.9.1-dev
cannam@133 9
cannam@133 10 Then install Jekyll:
cannam@133 11
cannam@133 12 sudo gem install jekyll
cannam@133 13
cannam@133 14 Now install Pygments and SetupTools to be able to install the CapnProto lexer.
cannam@133 15 On Debian based operating systems:
cannam@133 16
cannam@133 17 sudo apt-get install python-pygments python-setuptools
cannam@133 18
cannam@133 19 Next, install the custom Pygments syntax highlighter:
cannam@133 20
cannam@133 21 cd _plugins
cannam@133 22 sudo python capnp_lexer.py install
cannam@133 23 cd ..
cannam@133 24
cannam@133 25 Now you can launch a local server:
cannam@133 26
cannam@133 27 jekyll serve highlighter --watch
cannam@133 28
cannam@133 29 Edit, test, commit.
cannam@133 30
cannam@133 31 If you have permission, after you've pushed your changes back to github, you can make your changes live by running:
cannam@133 32
cannam@133 33 ./push-site.sh
cannam@133 34
cannam@133 35 Otherwise, send a pull request and let someone else actually push the new site.