Skip to content

Commit

Permalink
Update docs to point to Read the Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
straithe committed Nov 3, 2021
1 parent 13e9a97 commit d3f6d44
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
YARD Stick One, a sub-1 GHz wireless transceiver controlled by your computer
# YARD Stick One

project home: http://greatscottgadgets.com/yardstickone/
This repository contains hardware designs and software for YARD Stick One, a sub-1 GHz wireless transceiver controlled by your computer.

designed by Michael Ossmann <[email protected]>
Information on purchasing YARD Stick One: [https://greatscottgadgets.com/yardstickone/](https://greatscottgadgets.com/yardstickone/)

-------------------

# Documentation

Documentation for YARD Stick One can be viewed on [Read the Docs](https://yardstickone.readthedocs.io/en/latest/). The raw documenation files for YARD Stick One are in the [docs folder](https://github.com/greatscottgadgets/yardstick/tree/master/docs) in this repository and can be built locally by installing [Sphinx Docs](https://www.sphinx-doc.org/en/master/usage/installation.html) and running `make html`. Documentation changes can be submitted through pull request and suggestions can be made as GitHub issues.

--------------------

# Getting Help

Before asking for help with YARD Stick One, check to see if your question is listed in the [FAQ](https://yardstickone.readthedocs.io/en/latest/faq.html).

For assistance with YARD Stick One general use or development, please look at the [issues on the GitHub project](https://github.com/greatscottgadgets/yardstick). This is the preferred place to ask questions so that others may locate the answer to your question in the future.

We invite you to join our community discussions on [Discord](https://discord.gg/rsfMw3rsU8). Note that while technical support requests are welcome here, we do not have support staff on duty at all times and your questions are not guaranteed to be answered. Be sure to also submit an issue on GitHub if you’ve found a bug or if you want to ensure that your request will be tracked and not overlooked.

GitHub issues on this repository that are labelled "technical support" by Great Scott Gadgets employees can expect a response time of two weeks. We currently do not have expected response times for other GitHub issues or pull requests for this repository.

0 comments on commit d3f6d44

Please sign in to comment.