From 87305b3cefdd287188bb6c6434ea73ecb31d7f4d Mon Sep 17 00:00:00 2001 From: Pete Doherty Date: Mon, 4 Mar 2024 15:34:25 -0500 Subject: [PATCH] Update README.md note cargo install option in and flesh out build/install instructions in README --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6efa260..ff96d52 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,19 @@ more dependable (config is typechecked where possible) and simpler to install. It's also a great excuse for me to learn more about Rust, its ecosystem and compiling/distributing binaries for various platforms. -## How does it work? -- install tmux (>= 2.8), rust and cargo -- build and run with: `cargo build && ./target/debug/rmuxinator start Example.toml` +## TLDR; How do I use it? +- install tmux (>= 2.8), [rust and cargo](https://rustup.rs/) + +### Cargo +- install: `cargo install rmuxinator` +- run: `rmuxinator start Example.toml` + +### Source +#### `cargo build` +- build: `cargo build && ./target/debug/rmuxinator start Example.toml` +- run: `./target/debug/rmuxinator start Example.toml` +#### `cargo run` +- run: `cargo run start Example.toml` ## Documentation