From 4870df2d4a686224c28df302b1dcbb3761894b1e Mon Sep 17 00:00:00 2001 From: "Michal Krenek (Mikos)" Date: Thu, 10 Dec 2015 01:38:17 +0100 Subject: [PATCH] Installation instructions and todo --- README.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README.rst b/README.rst index f22847e..c919ed1 100644 --- a/README.rst +++ b/README.rst @@ -49,3 +49,44 @@ stick, use `kalibrate-rtl `_. You can move and zoom plot with mouse, change plot settings or export plots from right-click menu. Waterfall plot black/white levels and color lookup table can be changed in mini-histogram widget. + +Installation +------------ + +**Arch Linux:** +:: + + git clone https://aur.archlinux.org/qspectrumanalyzer.git + cd qspectrumanalyzer + makepkg -sri + +Or simply use `pacaur `_ (or any other AUR helper): +:: + + pacaur -S qspectrumanalyzer + +**Debian / Ubuntu:** +:: + + sudo apt-get install python3-pip python3-pyqt4 python3-numpy + sudo pip3 install qspectrumanalyzer + +Warning! ``pip`` will install packages system-wide by default, but you +should always use your distribution package manager for this. + +You can install it locally only for your current user by running this (without ``sudo``): +:: + + pip3 install --user qspectrumanalyzer + +Exacutables will be then placed in ``~/.local/bin`` directory, you can add it to your +PATH in ``~/.bashrc``. + +Todo: +----- + +- peak hold (maybe even with gradual fading, RTSA-like spectrum visualization similar to + `gr-fosphor `_) +- automatic peak detection / highlighting +- frequency markers / bookmarks with notes (even importing / exporting .csv file with + predefined channels, etc.)