README.md

KLEE Official Website

The KLEE website, built using Web Starter Kit and Jekyll.

Quickstart

Dependencies

• Ruby ≥ 2.0.0. You can use RVM or rbenv to install it. (A Ruby DevKit is required to build dependencies with native extensions.)

• Node.js

• Bundler. You can use gem install bundle to install it.

• Python. If you get errors such Liquid Exception: EPIPE when you try to run Jekyll, set Python 2.x as default (instead of Python 3.x).

Installation

Clone this repository and install all dependencies using:

$ bundle

Then, you can preview the site by running (at localhost:4000 by default):

$ bundle exec jekyll serve -w

To build the site, you can use:

$ bundle exec jekyll build

Contributing

Contributions, both to content and design are welcome and encouraged. To contribute, please submit a pull request.

Adding Release Documentation

The repository has old versions of the documentation in releases/docs/. To generate documentation for a new release, do the following:

1. Open _config.yml and

• Change is_release to true
• Add the releases folder to excludes
• Set current_version to the new KLEE version

2. Run the following command, where <VERSION> is the KLEE version:

$ jekyll build -d releases/docs/<VERSION> --baseurl /releases/docs/<VERSION>

3. Clear the changes made to _config.yml (e.g. by doing git reset --hard)
4. Add releases/docs/<VERSION> to the repository
5. Add an entry for the release in releases/index.md
6. Commit the changes

License

Creative Commons Attribution 3.0 Unported (CC BY 3.0)