Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
note cargo install option in and flesh out build/install instructions in README
  • Loading branch information
ethagnawl authored Mar 4, 2024
1 parent c44ddd2 commit 87305b3
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 87305b3

Please sign in to comment.