capnproto

FORK: Cap'n Proto serialization/RPC system - core tools and C++ library
git clone https://git.neptards.moe/neptards/capnproto.git
Log | Files | Refs | README | LICENSE

README.md (1054B)

      1 # Cap'n Proto Documentation
      2 
      3 This directory contains the "source code" for the Cap'n Proto web site.
      4 
      5 The site is built with [Jekyll](http://jekyllrb.com/), which depends on Ruby. 
      6 Start by installing ruby1.9.1-dev. On Debian-based operating systems:
      7 
      8     sudo apt-get install ruby-dev
      9 
     10 Then install Jekyll 3.8.1 (Jekyll 4.x will NOT work due as they removed Pygments support):
     11 
     12     sudo gem install jekyll -v 3.8.1
     13     sudo gem install pygments.rb
     14 
     15 Now install Pygments and SetupTools to be able to install the CapnProto lexer.
     16 On Debian based operating systems:
     17 
     18     sudo apt-get install python-pygments python-setuptools
     19 
     20 Next, install the custom Pygments syntax highlighter:
     21 
     22     cd _plugins
     23     sudo python capnp_lexer.py install
     24     cd ..
     25 
     26 Now you can launch a local server:
     27 
     28     jekyll _3.8.1_ serve --watch
     29 
     30 Edit, test, commit.
     31 
     32 If you have permission, after you've pushed your changes back to github, you can make your changes live by running:
     33 
     34     ./push-site.sh
     35 
     36 Otherwise, send a pull request and let someone else actually push the new site.