diff --git a/README.md b/README.md index ee793c7..0d62621 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,18 @@ A tmux wrapper and command shortener written in Rust. ReMux's goal is to wrap tmux commands to be both shorter, and oriented around session names instead of session IDs. -To further simplify developer usage, the `attach`, `detach`, `has`, and `new` -commands can be used without a target field, and will default to the name of -the Git repository root directory, if one is found. +To further simplify developer workflows, the `attach`, `detach`, `has`, and +`new` commands will default to the name of the root directory if used inside +a Git repository. -In their shortest forms, *every* ReMux command is as short or -shorter than its equivalent tmux command: +## Goals + +- Accelerating: Makes simple tmux workflows faster. +- Friendly: Easy to start using. +- Short: Every ReMux command is as short or shorter than its raw tmux equivalent. + +
+

Examples

```sh @@ -45,6 +51,8 @@ remux n -n foo ``` +
+ ## Dependencies ReMux depends on [tmux](https://github.com/tmux/tmux). @@ -55,34 +63,43 @@ ReMux depends on [tmux](https://github.com/tmux/tmux).
Release Binary -Copy the compiled binary from the releases page -to a directory in $PATH, such as /usr/bin/. + +Copy the compiled binary from the [releases page](https://git.vwolfe.io/valerie/remux/releases) +to a directory in `$PATH`, such as `/usr/bin/`. +
Compile from Source -Compile using cargo with the command cargo build --release and copy -the file from target/release/ to a directory in $PATH, -such as /usr/bin/. + +Compile using cargo with the command `cargo build --release` and copy the file +from `target/release/` to a directory in `$PATH`, such as `/usr/bin/`. +
makepkg (AUR) -Clone the AUR Repository and -run the command makepkg --install. + +Clone the [AUR Repository](https://aur.archlinux.org/remux.git) and run the +command `makepkg --install`. +
### Package Managers
Arch Linux (AUR): remux -Install the package from the remux AUR Package -using an AUR package manager such as paru. + +Install the package from the [`remux` AUR Package](https://aur.archlinux.org/packages/remux) +using an AUR package manager such as [`paru`](https://github.com/Morganamilo/paru"). +
Cargo: tmux-remux -Install the package using Cargo with the command cargo install tmux-remux. + +Install the package using Cargo with the command `cargo install tmux-remux`. +
## Configuration