pounder_test/docs/README.md

This folder represents the Github Pages site that is used to host Stabilizer's user guide.

The site is hosted with Jekyll and utilizes the "Just the Docs" theme.

To run locally:

1. Install Ruby
2. Install Jekyll
3. Install Bundler
4. From this directory:

bundle install
bundle exec jekyll serve

1. Navigate to localhost:4000/stabilizer/ in a web browser

Note: Some of the links in the docs rely on Cargo's documentation. To make all links work locally, run:

cargo doc --no-deps -p dsp -p miniconf -p stabilizer -p ad9959
cp -r target/thumbv7em-none-eabihf/doc docs/firmware