Skip to content

Commit 008012a

Browse files
author
zacharyburnett
committed
update configuration documentation
1 parent 76258ef commit 008012a

File tree

5 files changed

+255
-105
lines changed

5 files changed

+255
-105
lines changed

README.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,44 @@
55
[![license](https://img.shields.io/github/license/umdbpp/packetraven)](https://opensource.org/licenses/MIT)
66

77
PacketRaven is a command-line dashboard that retrieves location telemetry sent by high-altitude balloon payloads.
8-
8+
The program is designed to be run during a flight and display information in a terminal user interface (TUI):
99
![demo](https://media.githubusercontent.com/media/UMDBPP/PacketRaven/main/docs/images/demo.gif)
1010

11-
To install PacketRaven, download an executable from the [latest release](https://github.com/UMDBPP/PacketRaven/releases)
12-
and run it from the terminal with a
13-
[configuration file](https://packetraven.readthedocs.io/en/latest/configuration.html):
11+
## Features
12+
13+
- retrieve location telemetry from a variety of sources, including
14+
- https://amateur.sondehub.org
15+
- https://aprs.fi
16+
- a TNC-equipped radio connected via USB
17+
- a text file containing raw APRS frames
18+
- a GeoJSON file with telemetry attached to coordinates
19+
- retrieve balloon flight predictions from https://predict.sondehub.org
20+
- plot variables such as altitude and ascent rate over time
21+
- estimate landing time and location
22+
23+
## Installation
24+
25+
[Download an executable file from the latest release.](https://github.com/UMDBPP/PacketRaven/releases)
26+
27+
> **Note**
28+
> Alternatively, you may compile the program yourself:
29+
> ```shell
30+
> git clone https://github.com/UMDBPP/PacketRaven.git
31+
> cd packetraven
32+
> cargo build --release
33+
> ls target/release
34+
> ```
35+
36+
## Usage
37+
38+
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).
39+
40+
Then, run your executable from the terminal with the path to your configuration as the first argument:
1441
```shell
1542
./packetraven_Windows.exe examples/example_1.yaml
1643
```
44+
45+
You should then see the following in your terminal window:
1746
![starting screen](https://media.githubusercontent.com/media/UMDBPP/PacketRaven/main/docs/images/example1_log.png)
1847

1948
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
2251

2352
To quit, press `q` or `Esc`.
2453

25-
> **Note**
26-
> Alternatively, you may build the executable from source with Cargo:
27-
> ```shell
28-
> git clone https://github.com/UMDBPP/PacketRaven.git
29-
> cd packetraven
30-
> cargo build --release
31-
> ls target/release
32-
> ```

docs/rtd_environment.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ dependencies:
55
- python
66
- sphinx
77
- sphinx-mdinclude
8+
- sphinx_rtd_theme

0 commit comments

Comments
 (0)