cannam@62: # Cap'n Proto Documentation
cannam@62: 
cannam@62: This directory contains the "source code" for the Cap'n Proto web site.
cannam@62: 
cannam@62: The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby. 
cannam@62: Start by installing ruby1.9.1-dev. On Debian-based operating systems:
cannam@62: 
cannam@62:     sudo apt-get install ruby-dev
cannam@62: 
cannam@62: Then install Jekyll:
cannam@62: 
cannam@62:     sudo gem install jekyll pygments.rb
cannam@62: 
cannam@62: Now install Pygments and SetupTools to be able to install the CapnProto lexer.
cannam@62: On Debian based operating systems:
cannam@62: 
cannam@62:     sudo apt-get install python-pygments python-setuptools
cannam@62: 
cannam@62: Next, install the custom Pygments syntax highlighter:
cannam@62: 
cannam@62:     cd _plugins
cannam@62:     sudo python capnp_lexer.py install
cannam@62:     cd ..
cannam@62: 
cannam@62: Now you can launch a local server:
cannam@62: 
cannam@62:     jekyll serve --watch
cannam@62: 
cannam@62: Edit, test, commit.
cannam@62: 
cannam@62: If you have permission, after you've pushed your changes back to github, you can make your changes live by running:
cannam@62: 
cannam@62:     ./push-site.sh
cannam@62: 
cannam@62: Otherwise, send a pull request and let someone else actually push the new site.