Skip to content

Commit 87305b3

Browse files
authored
Update README.md
note cargo install option in and flesh out build/install instructions in README
1 parent c44ddd2 commit 87305b3

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,19 @@ more dependable (config is typechecked where possible) and simpler to install.
1212
It's also a great excuse for me to learn more about Rust, its ecosystem and
1313
compiling/distributing binaries for various platforms.
1414

15-
## How does it work?
16-
- install tmux (>= 2.8), rust and cargo
17-
- build and run with: `cargo build && ./target/debug/rmuxinator start Example.toml`
15+
## TLDR; How do I use it?
16+
- install tmux (>= 2.8), [rust and cargo](https://rustup.rs/)
17+
18+
### Cargo
19+
- install: `cargo install rmuxinator`
20+
- run: `rmuxinator start Example.toml`
21+
22+
### Source
23+
#### `cargo build`
24+
- build: `cargo build && ./target/debug/rmuxinator start Example.toml`
25+
- run: `./target/debug/rmuxinator start Example.toml`
26+
#### `cargo run`
27+
- run: `cargo run start Example.toml`
1828

1929
## Documentation
2030

0 commit comments

Comments
 (0)