kai
/
pounder_test
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
pounder_test/docs
History
Ryan Summers fb580edcee Updating Stabilizer to remove compile-time config parameters 2021-08-02 13:11:32 +02:00
..
assets Squashing manual changes 2021-07-15 13:28:19 +02:00
pages Updating Stabilizer to remove compile-time config parameters 2021-08-02 13:11:32 +02:00
Gemfile Fixing links, adding htmlproofer 2021-07-16 11:23:01 +02:00
Gemfile.lock Fixing links, adding htmlproofer 2021-07-16 11:23:01 +02:00
README.md Updating docs on telemetry 2021-07-16 14:25:37 +02:00
Rakefile Ignoring quartiq URLs not existing 2021-07-16 15:31:24 +02:00
_config.yml Reverting unintended config change 2021-07-16 15:15:42 +02:00
favicon.ico Squashing manual changes 2021-07-15 13:28:19 +02:00
index.md Apply suggestions from code review 2021-07-16 14:24:00 +02:00

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