Sojus07/hackrf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1176 from straithe/updateReadMeDocumentation

Browse Source 
Update Readme to have docs PDF build instructions
This commit is contained in:
Michael Ossmann
2022-09-23 14:22:02 -04:00
committed by GitHub
parent 5b98cf92d8 c1fb7a72a8
commit caf0cfde87
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Readme.md
View File

@ -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 while on Ubuntu:
* run `sudo apt install latexmk texlive-latex-extra`
* navigate to hackrf/docs on command line
* run the command `make latex`
* run the command `make latexpdf`
--------------------
# Getting Help