The stlab Documentation Has Moved!

The source of truth for STLab documentation is now housed in the libraries repository under the /docs directory. This repository has been archived and may be deleted without notice. Note that the history of this repository was preserved during the migration.

Legacy

Pull requests for typos, examples, and other improvements are welcome. To file an issue, please use the libraries repository.

Branch states

• master:

• develop:

Building (Mac)

You'll need Homebrew to make sure you have the most recent version of Ruby.

Setup

1. Clone the repo
2. brew install ruby
3. sudo gem install bundle jekyll github-pages liquid

Periodically run gem update and bundle update to make sure you have the latest jekyll tooling.

Building Docs

1. cd to repo directory
2. bundle exec jekyll serve --watch
3. Documentation viewable at localhost:4000
4. Modifying sources should auto-regenerate the documentation

Building Examples

1. ./build.sh will download dependencies, build, and run all the *.cpp files in the libraries directory.