Skip to content

Commit 38a666d

Browse files
author
zacharyburnett
committed
update README
1 parent 64adcdd commit 38a666d

File tree

1 file changed

+29
-39
lines changed

1 file changed

+29
-39
lines changed

README.md

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -20,56 +20,46 @@ The program is designed to be run during a flight and display information in a t
2020
- plot variables such as altitude and ascent rate over time
2121
- estimate landing time and location
2222

23-
## Installation
23+
## Instructions
2424

25-
[Download an executable (`packetraven_Windows.exe`, `packetraven_macOS`, or `packetraven_Linux`) from the latest release.](https://github.com/UMDBPP/PacketRaven/releases)
25+
1. Follow [these instructions](https://packetraven.readthedocs.io/en/latest/configuration.html) to create a new configuration file in a text editor, or use the following example file:
26+
```yaml
27+
# example.yaml
28+
connections:
29+
text:
30+
- path: ~/raw_aprs_frames.txt
31+
callsigns:
32+
- W3EAX-8
33+
- path: http://bpp.umd.edu/archives/Launches/NS-111_2022_07_31/APRS/W3EAX-8%20raw.txt
34+
```
2635
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/packetraven*
34-
> ```
36+
2. Download an executable from the [Releases page](https://github.com/UMDBPP/PacketRaven/releases).
3537
36-
## Usage
38+
3. Open a terminal window.
3739
38-
### `start`
40+
4. Run the executable you downloaded with the `start` subcommand, and give it the path to your configuration file:
41+
```shell
42+
packetraven_Windows.exe start example.yaml
43+
```
3944

40-
Run your executable from the terminal with the `start` subcommand and the path to your configuration file:
41-
```shell
42-
./packetraven_Windows.exe start examples/example_1.yaml
43-
```
44-
45-
[Instructions for creating a configuration file can be found in the documentation](https://packetraven.readthedocs.io/en/latest/configuration.html).
46-
Example configurations can be found in the `examples/` folder:
47-
48-
```yaml
49-
connections:
50-
text:
51-
- path: ~/raw_aprs_frames.txt
52-
callsigns:
53-
- W3EAX-8
54-
- path: http://bpp.umd.edu/archives/Launches/NS-111_2022_07_31/APRS/W3EAX-8%20raw.txt
55-
```
45+
> [!TIP]
46+
> Add `--help` to any command to show usage instructions.
5647

57-
You should then see the user interface. Resize your terminal window, or decrease the font size, as needed.
58-
![starting screen](https://github.com/UMDBPP/PacketRaven/blob/main/docs/images/example1_log.png)
48+
5. You should now see the user interface. Resize your terminal window or decrease the font size as needed.
49+
![starting screen](https://github.com/UMDBPP/PacketRaven/blob/main/docs/images/example1_log.png)
5950

60-
The left and right arrow keys (or `Tab` and `Shift+Tab`) cycle through active tabs,
61-
and the up and down arrow keys change the current plot (or scroll through log messages).
62-
![altitude telemetry plotted over time](https://github.com/UMDBPP/PacketRaven/blob/main/docs/images/example1_altitude.png)
51+
6. The left and right arrow keys (or `Tab` and `Shift+Tab`) cycle through active tabs, and the up and down arrow keys change the current plot (or scroll through log messages).
52+
![altitude telemetry plotted over time](https://github.com/UMDBPP/PacketRaven/blob/main/docs/images/example1_altitude.png)
6353

64-
To quit, press `q` or `Esc`.
54+
7. To quit, press `q` or `Esc`.
6555

66-
### `predict`
56+
## retrieve predictions
6757

68-
You can run the `predict` subcommand to retrieve a balloon flight prediction from a Tawhiri API:
58+
Use `predict` to retrieve a balloon flight prediction:
6959

7060
```shell
71-
./packetraven_Windows.exe predict "2023-08-16T10:00:00" -- -79 39 5 30000 9
61+
packetraven_Windows.exe predict "2023-08-16T10:00:00" -- -79 39 5 30000 9
7262
```
7363

74-
> **Note**\
75-
> Negative values must be prepended with `-- `, e.g. `-- -79`.:w
64+
> [!WARNING]
65+
> due to a limitation in the argument parser, you must prepend all negative values with `-- `; for instance, `-79` should be `-- -79`

0 commit comments

Comments
 (0)