This repository contains firmware and software for GreatFET.

Information on GreatFET and purchasing GreatFET: https://greatscottgadgets.com/greatfet/

Documentation for GreatFET can be viewed on Read the Docs. The raw documentation files for GreatFET are in the docs folder in this repository and can be built locally by installing Sphinx Docs and running make html. Documentation changes can be submitted through pull request and suggestions can be made as GitHub issues.

To create a PDF of the GreatFET documentation from the GreatFET repository while on Ubuntu:

• run sudo apt install latexmk texlive-latex-extra
• navigate to greatfet/docs on command line
• run the command make latex
• run the command make latexpdf

Before asking for help with GreatFET, check to see if your question is listed in the documentation.

For assistance with GreatFET general use or development, please look at the issues on the GitHub project. 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. Note that while technical support requests are welcome here, we do not have support staff on duty at all times. 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.