Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 2.53 KB

README.md

File metadata and controls

80 lines (50 loc) · 2.53 KB
Raw

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

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.

Contributing to the Publication List

Please open a pull request for missing publications that build upon or use KLEE. All list entries are ordered by publication date and follow the layout below:

1. [KLEE: Unassisted and Automatic Generation of High-Coverage Tests for Complex Systems Programs](http://www.doc.ic.ac.uk/~cristic/papers/klee-osdi-08.pdf)⎵⎵
⎵⎵Cristian Cadar, Daniel Dunbar, Dawson Engler⎵⎵
⎵⎵USENIX Symposium on Operating Systems Design and Implementation (OSDI 2008)⎵⎵
⎵⎵December 8-10, 2008, San Diego, CA, USA⎵⎵
⎵⎵**Klee is available [here](https://klee.github.io/).**

Note that the template language requires that two spaces (shown as ⎵) are added to every but the last line to insert line-breaks.

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 doxygen and releases folders to exclude
  • Set current_version to the new KLEE version
  1. Run the following command, where <VERSION> is the KLEE version (e.g., "v2.3"):
$ jekyll build -d releases/docs/<VERSION> --baseurl /releases/docs/<VERSION>
  1. Clear the changes made to _config.yml, except for the current_version
  2. Add releases/docs/<VERSION> to the repository
  3. Add an entry for the release in releases/index.md
  4. Commit the changes

License

Creative Commons Attribution 3.0 Unported (CC BY 3.0)