annotate src/capnproto-0.6.0/doc/README.md @ 148:b4bfdf10c4b3

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