diff --git a/README.md b/README.md index 187588c..515a46a 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,27 @@ https://rhelectronics.net/store/mppc-sipm-csi-tl-8x8x50mm-usb-gamma-spectrometer # Installation HOWTO Install. Development is currently done using Debian stable -(Bullseye/11), which uses Python 3.9. Perhaps do something like this, or +(Bullseye/11), which uses Python 3.9. + + +## Install Dependencies +Get system dependency and upgrade Python pip. +Perhaps do something like this, or set up a Python virtual environment. ``` sudo apt update -sudo apt install python3-pip +sudo apt install git python3-pip pip install --user --upgrade pip +``` + + +## Clone Git Repo +Get source code with `git`. + +``` +git clone https://spacecruft.org/spacecruft/witgit +cd witgit/ pip install --user --upgrade -r requirements.txt ``` @@ -51,12 +65,19 @@ audio recording. The next step is to process that file, then visualize, then categorize. Along these lines... ``` +mkdir -p data + ./witgit-rec # Record + ./witgit-proc [filename] # Process + ./witgit-view [filename] # View Plot -./witgit-wut [filename] # Categorize + +./witgit-wut [filename] # Categorize ``` +Files are automatically timestamped and written to the `data/` directory. + # Upstream The code will be built using bits from other free software / open source