Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 2.01 KB

README.md

File metadata and controls

35 lines (27 loc) · 2.01 KB

docs/

Start at the quickstart: ../sdr_dsp/README.md (install, extras, hear a station). Everything here is one layer deeper.

For users

File Who it is for
../sdr_dsp/README.md Anyone starting out: install and the FM quickstart.
MODULATIONS.md Deciding whether your signal is covered, and what "supported" means for it.
EXAMPLES.md Finding the example script that does what you want, and what it needs to run.
HARDWARE.md HackRF One owners: what the board can and can't do, and why it shapes the demods.
DC_SPIKE.md Anyone with a direct-conversion capture: where the DC spike comes from and the offset-tuning recipe.
sdr_dsp_REFERENCE.md Users who want the whole picture: architecture, module map, usage, limitations.

For contributors

File Who it is for
../CONTRIBUTING.md Anyone filing a bug, sharing a capture, or wondering why PRs are closed for now.
ADDING_AN_SDR.md Anyone pointing the library at a radio other than the HackRF: the IQSource/TXSink seam, the porting process and record.
dev_handbook/ Generated API handbook plus the scripts that produce it (CI checks it is current).

Maintainer notes

File Who it is for
TODO.md Open work in priority order, plus known limitations. The LOG's deferrals live here.
RELEASING.md The maintainer, cutting a version: one-time PyPI setup, the per-release checklist, what is not part of a release.
LOG.md The dated development log, newest first: what was tried, measured, and why.
notes/ One-off investigation notes (currently the packet-capture converter note).

Documentation is AI-assisted for spelling and structure; all mistakes are human and will take a revision or two to fix experimentally.