From af3b5718f49da5e0fc22f45bd5de7882ddedec9e Mon Sep 17 00:00:00 2001
From: Jeff Moe <moe@spacecruft.org>
Date: Sun, 31 Jul 2022 14:09:33 -0600
Subject: [PATCH] Upstream README

---
 README-upstream.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README-upstream.md

diff --git a/README-upstream.md b/README-upstream.md
new file mode 100644
index 0000000..617cd52
--- /dev/null
+++ b/README-upstream.md
@@ -0,0 +1,29 @@
+# pystrf
+Python based radio frequency satellite tracking.
+
+This is a python port of STRF (https://github.com/cbassa/strf), but will include additional functionality to work with SatNOGS HDF5 artifacts and advanced Doppler curve detection algorithms.
+
+Install dependencies with
+```
+pip install -r requirements.txt
+```
+Install the git large filesystem to download example spectra and run
+```
+git lfs init
+```
+Clone the repository via HTML
+```
+git clone https://gitlab.com/librespacefoundation/pystrf.git
+```
+or via SSH (you may have to add SSH keys to your gitlab account)
+```
+git clone git@gitlab.com:librespacefoundation/pystrf.git
+```
+
+## Usage
+
+To view data attached as example:
+
+```
+./rfplot.py -p data/2021-08-04T20_48_35 -c tle/classfd.tle
+```