annotate src/capnproto-0.6.0/doc/README.md @ 84:08ae793730bd

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