From 2e4a2a9e30ebd562244c0d3397700ff84f1d4c89 Mon Sep 17 00:00:00 2001 From: straithe Date: Fri, 23 Sep 2022 13:06:42 -0400 Subject: [PATCH] Update Readme to have docs PDF build instructions --- Readme.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Readme.md b/Readme.md index f774c0b4..5c79d688 100644 --- a/Readme.md +++ b/Readme.md @@ -17,6 +17,12 @@ Information on HackRF and purchasing HackRF: https://greatscottgadgets.com/hackr 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. +To create a PDF of the HackRF One documentation from the HackRf repository: +* navigate to hackrf/docs on command line +* run the command `make latex` +* navigate to hackrf/docs/latex +* run the command `make latexpdf` + -------------------- # Getting Help