OpenFPGA/libs/EXTERNAL/capnproto/doc
tangxifan f1bafffa87 add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
..
_includes add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
_layouts add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
_plugins add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
_posts add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
images add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
javascripts add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
news add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
slides-2017.05.18 add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
stylesheets add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
README.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
_config.yml add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
_config_next.yml add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
capnp-tool.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
cxx.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
cxxrpc.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
encoding.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
faq.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
feed.xml add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
index.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
install.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
language.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
otherlang.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
push-site.sh add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
roadmap.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00
rpc.md add vpr8 libs and core engine for further integration 2020-01-03 16:14:42 -07:00

README.md

Cap'n Proto Documentation

This directory contains the "source code" for the Cap'n Proto web site.

The site is built with Jekyll, 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.