Merge pull request #352 from andrewdavidmackenzie/pigg-347-installing

Add installing instructions

Cargo.toml

@@ -65,10 +65,11 @@ lyon_algorithms = { version = "1.0", default-features = false }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
 tempfile = "3"
+serial_test = "3.1.1"
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 rfd = "0.14.1"
-clap = { version = "4.5.13", default-features = false, features = ["std", "help", "error-context"]}
+clap = { version = "4.5.13", default-features = false, features = ["std", "help", "error-context"] }
 
 [target.aarch64-unknown-linux-gnu.dependencies]
 rppal = "0.18.0"

INSTALLING.md

@@ -0,0 +1,64 @@
+# Installing
+
+Up-to-date instructions for installing are also be in the release notes of the
+[latest release](https://github.com/andrewdavidmackenzie/pigg/releases/latest)
+
+## Install prebuilt binaries via shell script
+
+If your platform supports `sh` (and you have `curl` installed), then you can install the appropriate prebuilt binary
+using:
+
+```sh
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/andrewdavidmackenzie/pigg/releases/download/0.3.4/pigg-installer.sh | sh
+```
+
+(example shown is for version 0.3.4. Check
+the [latest release](https://github.com/andrewdavidmackenzie/pigg/releases/latest) page
+for the line to be used for the latest release, after 0.3.4)
+
+## Install prebuilt binaries via Homebrew
+
+For platforms that use homebrew, you can install the appropriate prebuilt binary using:
+
+```sh
+brew install andrewdavidmackenzie/pigg-tap/pigg
+```
+
+## Install pre-built binaries via "cargo binstall"
+
+If you have installed a rust toolchain, then you can install `cargo-binstall` from [crates.io](https://crates.io)
+and then use it to install the pre-built binaries, without building from source:
+
+```sh
+cargo binstall pigg
+```
+
+## Other Installation options for Windows
+
+See the Downloads section in the [latest release](https://github.com/andrewdavidmackenzie/pigg/releases/latest)
+where you can find a downloadable "msi" installer for Windows that will install the appropriate pre-built binary.
+
+You can also download a "zip" file with the prebuilt binary for Windows and run or install that manually.
+
+## Other Installation options for Mac
+
+See the Downloads section in the [latest release](https://github.com/andrewdavidmackenzie/pigg/releases/latest)
+where you can find "tar.xz" downloads for x86 and Apple Silicon Macs.
+
+Expand the downloaded file with `tar -xvf` and then run or manually install the binary
+
+## Other Installation options for Mac
+
+See the Downloads section in the [latest release](https://github.com/andrewdavidmackenzie/pigg/releases/latest)
+where you can find "tar.xz" downloads for Linux x86 machines
+
+Expand the downloaded file with `tar -xvf` and then run or manually install the binary
+
+## Checking the version installed
+
+Check the version you have installed is the latest with
+
+```sh
+piggui --version
+piglet --version
+```

README.md

@@ -38,28 +38,13 @@ hardware remotely.
   </tr>
 </table>
 
-## Latest NEW Feature - Networked GPIO!
+## Latest NEW Feature - pre-built images and installers
 
-* The GUI (`piggui`) can connect to a Pi (that is running `piglet`) over the network, to control and view the GPIO
-  hardware
-  from a distance. The GUI can run on Mac, Linux, Windows or Raspberry Pis. Events are timestamped at source (as
-  close to the hardware as possible) so network delays should not affect the waveforms displayed. Provide us
-  feedback and ideas related to networking in Discussions or GH issues.
-* The data required to connect to a remote node via iroh-net is called the `nodeid`. `piglet` prints this out for you if
-  it
-  is started in the foreground. When `piglet` has been started as a system service, start another instance in the
-  foreground and this will detect the background instance and display its `nodeid` for you then exit.
-* Take the `nodeid` and either supply it as a command line option to `piggui` (`--nodeid $nodeid`, prefixed with `-- `
-  if using
-  `cargo run`) or enter it into the GUI. To connect to a remote instance from the GUI, click on the "hardware menu" in
-  the
-  left of the info bar at the bottom of the screen and select the "Connect to remote Pi..:" menu item. Then enter the
-  `nodeid` into the field provided and hit "Connect"
-
-Here are two videos showing the two ways to use it, with piglet running on a RPi shown via VNC.
+We have added pre-built images for different OS and CPU architecture, along with installers, to the automated
+release process using `cargo dist`. See [INSTALLING.md](INSTALLING.md) for details.
 
-* Video with Dialog: https://youtu.be/aToJ1aT7NeM
-* Video using CLI argument: https://youtu.be/zcEa_Oke014
+Up-to-date instructions for installing are also be in the release notes of the
+[latest release](https://github.com/andrewdavidmackenzie/pigg/releases/latest)
 
 ## Other Features
 
@@ -75,6 +60,20 @@ Here are two videos showing the two ways to use it, with piglet running on a RPi
   inversions of the stable level, plus a waveform view showing the recent history of the level set on the Output.
 - GPIO configurations can be loaded at startup with a command line filename option, or loaded via
   file-picker from the UI or saved to file via file picker.
+- The GUI (`piggui`) can connect to a Pi (that is running `piglet`) over the network, to control and view the GPIO
+  hardware from a distance. The GUI can run on Mac, Linux, Windows or Raspberry Pis. Events are timestamped at source
+  (as close to the hardware as possible) so network delays should not affect the waveforms displayed. Provide us
+  feedback and ideas related to networking in Discussions or GH issues.
+- The data required to connect to a remote node via iroh-net is called the `nodeid`. `piglet` prints this out for you
+  if it is started in the foreground. When `piglet` has been started as a system service, start another instance in the
+  foreground and this will detect the background instance and display its `nodeid` for you then exit.
+- Take the `nodeid` and either supply it as a command line option to `piggui` (`--nodeid $nodeid`, prefixed with `-- `
+  if using `cargo run`) or enter it into the GUI. To connect to a remote instance from the GUI, click on the
+  "hardware menu" in the left of the info bar at the bottom of the screen and select the "Connect to remote Pi..:"
+  menu item. Then enter the `nodeid` into the field provided and hit "Connect"
+- Here are two videos showing the two ways to use it, with piglet running on a RPi shown via VNC.
+    - Video with Dialog: https://youtu.be/aToJ1aT7NeM
+    - Video using CLI argument: https://youtu.be/zcEa_Oke014
 
 You can see more gifs and videos of features [here](assets/features.md)
 
@@ -111,41 +110,27 @@ and input on how integrate new functionalities (e.g. I2C buses, SPI, UART, etc.)
 Please let us know what you think, and suggestions, via
 [Discussions](https://github.com/andrewdavidmackenzie/pigg/discussions) or GH issues.
 
-## Short-term Roadmap
+## Roadmap
 
 We have identified a number of areas we would like to work on after this initial release,
 but would really appreciate your input on what could be most useful or just the coolest,
 many have GH issues.
 
-- Automation of release process and publishing
-  packages [Issue #85](https://github.com/andrewdavidmackenzie/pigg/issues/85)
 - Pre-built binaries for install on Raspberry Pi [Issue #112](https://github.com/andrewdavidmackenzie/pigg/issues/112)
   and easier install [Issue #111](https://github.com/andrewdavidmackenzie/pigg/issues/111)
 - Expand support beyond Inputs and Outputs ( e.g. Clocks, PWM, I2C, UART, SPI etc.).
   Issue [#53](https://github.com/andrewdavidmackenzie/pigg/issues/53),
   [#52](https://github.com/andrewdavidmackenzie/pigg/issues/52), [#5](https://github.com/andrewdavidmackenzie/pigg/issues/5)
 - True logical layout, grouping pins by function [Issue #94](https://github.com/andrewdavidmackenzie/pigg/issues/94)
-
-## Further out ideas
-
 - Allow connections between pins [Issue #95](https://github.com/andrewdavidmackenzie/pigg/issues/95)
 - Pico support for a headless hardware backend accessed over the network
 - Trigger a script or WebAssembly plugin on an input event (edge, level, etc.)
 
 ## Installing
 
-We have work planned to produce pre-built binaries for supported platforms, and ways to install them
-directly.
-
-Prior to that, to install `piggui` and `piglet` you will have to build from source, either using `cargo install`,
-or `cargo build` or `make` from a clone of the repo or a download of a release source tarball/zip.
-
-See the section below for details.
-
-This is an area where we welcome ideas, input and contributions - please post your thoughts to the
-[Discussions](https://github.com/andrewdavidmackenzie/pigg/discussions)
+TODO
 
-## Building Piggui and Piglet from Source
+## Building from Source
 
 See [BUILDING.md](BUILDING.md)
 

tests/piglet.rs

@@ -1,17 +1,24 @@
+use serial_test::serial;
 use std::io::{BufRead, BufReader};
 use std::path::PathBuf;
 use std::process::{Command, Stdio};
 
 #[cfg(not(target_arch = "wasm32"))]
-pub fn run_piglet(config: Option<PathBuf>) -> String {
+pub fn run_piglet(options: Vec<String>, config: Option<PathBuf>) -> String {
     let crate_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
     let mut piglet_command = Command::new("cargo");
 
-    let mut args = vec!["run".to_string(), "--bin".to_string(), "piglet".to_string()];
+    let mut args = vec![
+        "run".to_string(),
+        "--bin".to_string(),
+        "piglet".to_string(),
+        "--".into(),
+    ];
+
+    args.extend(options);
 
     // If a config file path was supplied, add it as a CLI argument
     if let Some(config_path) = config {
-        args.push("--".to_string());
         let path = config_path.as_path().to_string_lossy().to_string();
         args.push(path);
     }
@@ -53,11 +60,33 @@ pub fn run_piglet(config: Option<PathBuf>) -> String {
     target_arch = "wasm32"
 )))]
 #[test]
+#[serial]
 fn node_id_is_output() {
-    let output = run_piglet(None);
+    let output = run_piglet(vec![], None);
     println!("Output: {}", output);
     assert!(
         output.contains("nodeid"),
         "Output of piglet does not contain nodeid"
     );
 }
+
+#[cfg(not(any(
+    all(
+        target_os = "linux",
+        any(target_arch = "aarch64", target_arch = "arm"),
+        target_env = "gnu"
+    ),
+    target_arch = "wasm32"
+)))]
+#[test]
+#[serial]
+fn version_number() {
+    let output = run_piglet(vec!["--version".into()], None);
+    println!("Output: {}", output);
+    assert!(
+        output.contains("piglet"),
+        "Output of piglet does not contain version"
+    );
+    let version = output.split(' ').nth(1).unwrap().trim();
+    assert_eq!(version, env!("CARGO_PKG_VERSION"));
+}