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