changed run to start and updated demo tape

UMDBPP · Aug 17, 2023 · e5ff061 · e5ff061
1 parent 686254f
commit e5ff061
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 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://github.com/UMDBPP/PacketRaven/blob/main/docs/images/demo.gif)
+![demo](https://github.com/UMDBPP/PacketRaven/blob/main/docs/demo/demo.gif)
 
 ## Features
 
@@ -35,11 +35,11 @@ The program is designed to be run during a flight and display information in a t
 
 ## Usage
 
-### `run`
+### `start`
 
-Run your executable from the terminal with the `run` subcommand and the path to your configuration file:
+Run your executable from the terminal with the `start` subcommand and the path to your configuration file:
 ```shell
-./packetraven_Windows.exe run examples/example_1.yaml
+./packetraven_Windows.exe start examples/example_1.yaml
 ```
 
 [Instructions for creating a configuration file can be found in the documentation](https://packetraven.readthedocs.io/en/latest/configuration.html).

diff --git a/docs/demo/demo.gif b/docs/demo/demo.gif
diff --git a/docs/images/demo.png → docs/demo/demo.png b/docs/images/demo.png → docs/demo/demo.png
diff --git a/docs/images/demo.tape → docs/demo/demo.tape b/docs/images/demo.tape → docs/demo/demo.tape
@@ -1,13 +1,13 @@
 Output docs/images/demo.gif
 
-Set Shell nu
+Set Shell bash
 Set FontSize 20
 Set Width 1200
 Set Height 700
 Set Padding 0
 Set Theme "Catppuccin Macchiato"
 
-Type "./packetraven examples/example_1.yaml"
+Type "./packetraven start examples/example_1.yaml"
 Sleep 500ms
 Enter
 Sleep 2.5s
@@ -19,7 +19,7 @@ Up
 Sleep 3s
 Escape
 Sleep 500ms
-Type "./packetraven examples/example_3.yaml"
+Type "./packetraven start examples/example_3.yaml"
 Sleep 500ms
 Enter
 Sleep 2.5s
@@ -29,7 +29,7 @@ Right
 Sleep 3s
 Escape
 Sleep 500ms
-Type "./packetraven demo.yaml"
+Type "./packetraven start docs/demo/demo.yaml"
 Sleep 500ms
 Enter
 Sleep 4.5s

diff --git a/docs/demo/demo.yaml b/docs/demo/demo.yaml
@@ -0,0 +1,13 @@
+callsigns:
+  - SQ5RB-11
+  - BSS43
+  - W5BII-11
+  - KB6USJ-11
+
+time:
+  start: 2023-08-16 00:00:00
+  end: 2023-08-18 00:00:00
+
+connections:
+  sondehub: {}
+
diff --git a/docs/images/demo.gif b/docs/images/demo.gif
diff --git a/src/main.rs b/src/main.rs
@@ -28,7 +28,7 @@ struct PacketravenCommand {
 #[derive(clap::Subcommand)]
 enum Command {
     /// run program from configuration
-    Run {
+    Start {
         /// file path to configuration
         config_file: std::path::PathBuf,
     },
@@ -67,7 +67,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let arguments = PacketravenCommand::parse();
 
     match arguments.command {
-        Command::Run { config_file } => {
+        Command::Start { config_file } => {
             let file = std::fs::File::open(config_file).unwrap();
             let configuration: crate::configuration::RunConfiguration =
                 serde_yaml::from_reader(file).expect("error reading configuration");