annotate src/capnproto-git-20161025/doc/README.md @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 9530b331f8c1
children
rev   line source
cannam@48 1 # Cap'n Proto Documentation
cannam@48 2
cannam@48 3 This directory contains the "source code" for the Cap'n Proto web site.
cannam@48 4
cannam@48 5 The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby.
cannam@48 6 Start by installing ruby1.9.1-dev. On Debian-based operating systems:
cannam@48 7
cannam@48 8 sudo apt-get install ruby1.9.1-dev
cannam@48 9
cannam@48 10 Then install Jekyll:
cannam@48 11
cannam@48 12 sudo gem install jekyll
cannam@48 13
cannam@48 14 Now install Pygments and SetupTools to be able to install the CapnProto lexer.
cannam@48 15 On Debian based operating systems:
cannam@48 16
cannam@48 17 sudo apt-get install python-pygments python-setuptools
cannam@48 18
cannam@48 19 Next, install the custom Pygments syntax highlighter:
cannam@48 20
cannam@48 21 cd _plugins
cannam@48 22 sudo python capnp_lexer.py install
cannam@48 23 cd ..
cannam@48 24
cannam@48 25 Now you can launch a local server:
cannam@48 26
cannam@48 27 jekyll serve highlighter --watch
cannam@48 28
cannam@48 29 Edit, test, commit.
cannam@48 30
cannam@48 31 If you have permission, after you've pushed your changes back to github, you can make your changes live by running:
cannam@48 32
cannam@48 33 ./push-site.sh
cannam@48 34
cannam@48 35 Otherwise, send a pull request and let someone else actually push the new site.