diff src/capnproto-0.6.0/doc/README.md @ 62:0994c39f1e94

Cap'n Proto v0.6 + build for OSX
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 22 May 2017 10:01:37 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/capnproto-0.6.0/doc/README.md	Mon May 22 10:01:37 2017 +0100
@@ -0,0 +1,35 @@
+# Cap'n Proto Documentation
+
+This directory contains the "source code" for the Cap'n Proto web site.
+
+The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby. 
+Start by installing ruby1.9.1-dev. On Debian-based operating systems:
+
+    sudo apt-get install ruby-dev
+
+Then install Jekyll:
+
+    sudo gem install jekyll pygments.rb
+
+Now install Pygments and SetupTools to be able to install the CapnProto lexer.
+On Debian based operating systems:
+
+    sudo apt-get install python-pygments python-setuptools
+
+Next, install the custom Pygments syntax highlighter:
+
+    cd _plugins
+    sudo python capnp_lexer.py install
+    cd ..
+
+Now you can launch a local server:
+
+    jekyll serve --watch
+
+Edit, test, commit.
+
+If you have permission, after you've pushed your changes back to github, you can make your changes live by running:
+
+    ./push-site.sh
+
+Otherwise, send a pull request and let someone else actually push the new site.