Remove test results (#95)

.github/workflows/tests.yml

@@ -29,12 +29,7 @@ jobs:
         run: sudo apt install -y pkg-config libusb-1.0-0-dev libftdi1-dev libudev-dev
       - uses: actions/checkout@v3
       - uses: actions-rust-lang/setup-rust-toolchain@v1
-      - run: cargo install cargo2junit
-      - run: cargo test -- -Z unstable-options --format json | cargo2junit > results.xml
-      - uses: test-summary/action@v2
-        with:
-          paths: "results.xml"
-        if: always()
+      - run: cargo test
   test_slow:
     name: test slow (${{ matrix.runs-on }})
     runs-on: ${{ matrix.runs-on }}
@@ -49,12 +44,7 @@ jobs:
         run: sudo apt install -y pkg-config libusb-1.0-0-dev libftdi1-dev libudev-dev
       - uses: actions/checkout@v3
       - uses: actions-rust-lang/setup-rust-toolchain@v1
-      - run: cargo install cargo2junit
-      - run: cargo test -- --ignored -Z unstable-options --format json | cargo2junit > results.xml
-      - uses: test-summary/action@v2
-        with:
-          paths: "results.xml"
-        if: always()
+      - run: cargo test
   # test_all_features:
   #   name: test all features (${{ matrix.runs-on }})
   #   runs-on: ${{ matrix.runs-on }}
@@ -84,12 +74,7 @@ jobs:
   #       run: sudo apt install -y pkg-config libusb-1.0-0-dev libftdi1-dev libudev-dev
   #     - uses: actions/checkout@v3
   #     - uses: actions-rust-lang/setup-rust-toolchain@v1
-  #     - run: cargo install cargo2junit
-  #     - run: cargo test --all-features -- --include-ignored -Z unstable-options --format json | cargo2junit > results.xml
-  #     - uses: test-summary/action@v2
-  #       with:
-  #         paths: "results.xml"
-  #       if: always()
+  #     - run: cargo test
   build:
     runs-on: ${{ matrix.runs-on }}
     strategy:

Cargo.toml

@@ -22,7 +22,7 @@ postgres = ["dep:postgres"]
 [dependencies]
 aprs-parser = ">=0.4.0"
 chrono = { version = ">=0.4.24", features = ["clock"] }
-clap = { version = ">=4.2.7", features = ["derive"] }
+clap = { version = ">=4.3.1", features = ["derive"] }
 custom_error = ">=1.9.2"
 geo = { version = ">=0.24.1", features = ["serde"] }
 geojson = ">=0.24.0"

README.md

@@ -1,19 +1,16 @@
-PacketRaven
-===========
+# PacketRaven
 
 [![tests](https://github.com/UMDBPP/PacketRaven/workflows/tests/badge.svg)](https://github.com/UMDBPP/PacketRaven/actions?query=workflow%3Atests)
 [![docs](https://readthedocs.org/projects/packetraven/badge/?version=latest)](https://packetraven.readthedocs.io/en/latest/?badge=latest)
 [![license](https://img.shields.io/github/license/umdbpp/packetraven)](https://opensource.org/licenses/MIT)
 
-![demo](https://media.githubusercontent.com/media/UMDBPP/PacketRaven/main/docs/images/demo.gif)
-
-Installation and Usage
-----------------------
+PacketRaven is a command-line dashboard that retrieves location telemetry sent by high-altitude balloon payloads.
 
-Download an executable from the [latest release](https://github.com/UMDBPP/PacketRaven/releases)
-and run it from the terminal, passing the path to a 
-[configuration file](https://packetraven.readthedocs.io/en/latest/configuration.html).
+![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):
 ```shell
 ./packetraven_Windows.exe examples/example_1.yaml
 ```
@@ -26,7 +23,7 @@ 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 yourself with Cargo:
+> Alternatively, you may build the executable from source with Cargo:
 > ```shell
 > git clone https://github.com/UMDBPP/PacketRaven.git
 > cd packetraven

src/main.rs

@@ -20,15 +20,15 @@ lazy_static::lazy_static! {
 
 #[derive(Parser)]
 #[command(author, version, about, long_about = None)]
-struct Cli {
+struct PacketravenCommand {
     // configuration file to read
-    configuration_filename: std::path::PathBuf,
+    config_file: std::path::PathBuf,
 }
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let arguments = Cli::parse();
+    let arguments = PacketravenCommand::parse();
 
-    let configuration_file = std::fs::File::open(arguments.configuration_filename).unwrap();
+    let configuration_file = std::fs::File::open(arguments.config_file).unwrap();
     let configuration: crate::configuration::RunConfiguration =
         serde_yaml::from_reader(configuration_file).expect("error reading configuration");