pounder_test/docs
Ryan Summers f67a56c2cd
Apply suggestions from code review
Co-authored-by: Robert Jördens <rj@quartiq.de>
2021-07-16 14:24:00 +02:00
..
assets Squashing manual changes 2021-07-15 13:28:19 +02:00
pages Apply suggestions from code review 2021-07-16 14:24:00 +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 Squashing manual changes 2021-07-15 13:28:19 +02:00
Rakefile Adding Rakefile 2021-07-16 13:16:30 +02:00
_config.yml Squashing manual changes 2021-07-15 13:28:19 +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 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 --bins
cp -r target/thumbv7em-none-eabihf/doc docs/firmware