pounder_test/docs
bors[bot] 1a75859311
Merge #430
430: Adding docker instructions r=ryan-summers a=ryan-summers

This PR fixes #429 by updating the getting started page to direct users to run Mosquitto through docker. The experience is honestly a lot better on all platforms (in my experience).

Co-authored-by: Ryan Summers <ryan.summers@vertigo-designs.com>
2021-08-09 11:58:17 +00:00
..
assets Squashing manual changes 2021-07-15 13:28:19 +02:00
pages Merge #430 2021-08-09 11:58:17 +00: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