From 1edda5bae3d3f92f42bccf2d98983ef776f8539f Mon Sep 17 00:00:00 2001 From: mhostetter Date: Sun, 9 Jul 2023 17:00:39 -0400 Subject: [PATCH] Add more detail to the `README` --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 9af0874dd..dc4e6c279 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ A Python package for software-defined radio. +> Enjoying the library? Give us a :star: on [GitHub](https://github.com/mhostetter/sdr)! + ## Features - Filters: @@ -31,3 +33,20 @@ A Python package for software-defined radio. - Phase-locked loops: - Loop filter (`sdr.LoopFilter`) - Closed-loop PLL analysis (`sdr.ClosedLoopPLL`) + +## Documentation + +The documentation for `sdr` is located at https://mhostetter.github.io/sdr/latest/. + +## Install the package + +The latest version of `sdr` can be installed from [PyPI](https://pypi.org/project/sdr/) using `pip`. + +```console +$ python3 -m pip install sdr +``` + +## Examples + +There are detailed examples published at https://mhostetter.github.io/sdr/latest/examples/iir-filter/. +The Jupyter notebooks behind the examples are available for experimentation in `docs/examples/`.