update configuration documentation

README.md

@@ -5,15 +5,44 @@
 [![license](https://img.shields.io/github/license/umdbpp/packetraven)](https://opensource.org/licenses/MIT)
 
 PacketRaven is a command-line dashboard that retrieves location telemetry sent by high-altitude balloon payloads.
-
+The program is designed to be run during a flight and display information in a terminal user interface (TUI):
 ![demo](https://media.githubusercontent.com/media/UMDBPP/PacketRaven/main/docs/images/demo.gif)
 
-To install PacketRaven, download an executable from the [latest release](https://github.com/UMDBPP/PacketRaven/releases)
-and run it from the terminal with a 
-[configuration file](https://packetraven.readthedocs.io/en/latest/configuration.html):
+## Features
+
+- retrieve location telemetry from a variety of sources, including
+  - https://amateur.sondehub.org
+  - https://aprs.fi
+  - a TNC-equipped radio connected via USB
+  - a text file containing raw APRS frames
+  - a GeoJSON file with telemetry attached to coordinates
+- retrieve balloon flight predictions from https://predict.sondehub.org
+- plot variables such as altitude and ascent rate over time
+- estimate landing time and location
+
+## Installation
+
+[Download an executable file from the latest release.](https://github.com/UMDBPP/PacketRaven/releases)
+
+> **Note**
+> Alternatively, you may compile the program yourself:
+> ```shell
+> git clone https://github.com/UMDBPP/PacketRaven.git
+> cd packetraven
+> cargo build --release
+> ls target/release
+> ```
+
+## Usage
+
+First, you need a configuration file. You may use one from the `examples/` directory in this repository, or [write one yourself](https://packetraven.readthedocs.io/en/latest/configuration.html).
+
+Then, run your executable from the terminal with the path to your configuration as the first argument:
 ```shell
 ./packetraven_Windows.exe examples/example_1.yaml
 ```
+
+You should then see the following in your terminal window:
 ![starting screen](https://media.githubusercontent.com/media/UMDBPP/PacketRaven/main/docs/images/example1_log.png)
 
 The left and right arrow keys (or `Tab` and `Shift+Tab`) cycle through active tabs, 
@@ -22,11 +51,3 @@ and the up and down arrow keys change the current plot (or scroll through log me
 
 To quit, press `q` or `Esc`.
 
-> **Note**
-> Alternatively, you may build the executable from source with Cargo:
-> ```shell
-> git clone https://github.com/UMDBPP/PacketRaven.git
-> cd packetraven
-> cargo build --release
-> ls target/release
-> ```

docs/rtd_environment.yaml

@@ -5,3 +5,4 @@ dependencies:
   - python
   - sphinx
   - sphinx-mdinclude
+  - sphinx_rtd_theme