The KLEE website, built using Web Starter Kit and Jekyll.
-
Ruby ≥ 2.0.0. You can use RVM or rbenv to install it. (A Ruby DevKit is required to build dependencies with native extensions.)
-
Bundler. You can use
gem install bundleto install it. -
Python. If you get errors such
Liquid Exception: EPIPEwhen you try to run Jekyll, set Python 2.x as default (instead of Python 3.x).
Clone this repository and install all dependencies using:
$ bundleThen, you can preview the site by running (at localhost:4000 by default):
$ bundle exec jekyll serve -wTo build the site, you can use:
$ bundle exec jekyll buildContributions, both to content and design are welcome and encouraged. To contribute, please submit a pull request.
The repository has old versions of the documentation in releases/docs/. To generate documentation for a new release, do the following:
- Open
_config.ymland
- Change
is_releasetotrue - Add the
releasesfolder toexcludes - Set
current_versionto the new KLEE version
- Run the following command, where
<VERSION>is the KLEE version:
$ jekyll build -d releases/docs/<VERSION> --baseurl /releases/docs/<VERSION>
- Clear the changes made to
_config.yml(e.g. by doinggit reset --hard) - Add
releases/docs/<VERSION>to the repository - Add an entry for the release in
releases/index.md - Commit the changes
Creative Commons Attribution 3.0 Unported (CC BY 3.0)