From 2fd10c1554ba6b3e8604603469c9a0c7957070e5 Mon Sep 17 00:00:00 2001 From: Straithe Date: Wed, 22 Sep 2021 18:50:10 -0400 Subject: [PATCH] Update HackRF readme (#962) * Updated HackRF readme --- Readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 068bd34d..76460a43 100644 --- a/Readme.md +++ b/Readme.md @@ -15,7 +15,7 @@ Information on HackRF and purchasing HackRF: https://greatscottgadgets.com/hackr # Documentation -Documentation for HackRF can be viewed on [Read the Docs](https://hackrf.readthedocs.io/en/latest/). The raw documenation files for HackRF are in the [docs folder](https://github.com/mossmann/hackrf/tree/master/docs) in this repository. Documentation changes can be submitted through pull request and suggestions can be made as GitHub issues. +Documentation for HackRF can be viewed on [Read the Docs](https://hackrf.readthedocs.io/en/latest/). The raw documenation files for HackRF are in the [docs folder](https://github.com/mossmann/hackrf/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. -------------------- @@ -25,7 +25,7 @@ Before asking for help with HackRF, check to see if your question is listed in t For assistance with HackRF general use or development, please look at the [issues on the GitHub project](https://github.com/mossmann/hackrf/issues). 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) and [IRC](https://web.libera.chat/#hackrf). 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. +We invite you to join our community discussions on [Discord](https://discord.gg/rsfMw3rsU8) and [IRC](https://web.libera.chat/#hackrf). 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. If you prefer email then you may use the [HackRF-dev mailing list](https://pairlist9.pair.net/mailman/listinfo/hackrf-dev) instead. You can view the [list archives](https://pairlist9.pair.net/pipermail/hackrf-dev/) for past discussions.