Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write a background/getting started document #87

Closed
ryan-summers opened this issue Oct 7, 2020 · 1 comment · Fixed by #89
Closed

Write a background/getting started document #87

ryan-summers opened this issue Oct 7, 2020 · 1 comment · Fixed by #89
Assignees
@ryan-summers
Milestone
0.1

Comments

@ryan-summers
Copy link
Member

Add documentation on how to get started working with Booster.

The document should include:

  • Information about how to get an MQTT broker running and connected to Booster
  • Information as to how the buttons operate
  • Instructions on how to configure channels
  • Instructions on how to modify settings
  • Instructions to save configurations
@ryan-summers ryan-summers added this to the 0.1 milestone Oct 7, 2020
@ryan-summers ryan-summers self-assigned this Oct 7, 2020
@jordens
Copy link
Member

jordens commented Oct 7, 2020

Good!

  • Definition of red/orange/green LED meaning
  • DFU procedure (done)

Since this isn't a huge amount of docs, it's probably easiest to just put a markdown into the repo. Alternatively cargo doc and continuously deploy to some github.io repo (but without the source code and its doc)....

@ryan-summers ryan-summers mentioned this issue Oct 8, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ryan-summers ryan-summers

Labels
None yet
Projects
None yet
Milestone
0.1
Development

Successfully merging a pull request may close this issue.

Adding documentation for using Booster quartiq/booster
2 participants
@jordens @ryan-summers