Compare commits

..

No commits in common. "390950a7e6efc36dfb8a4eb335f3822e0a2178d3" and "41a64f039f8112f5b80a7e66bbecf2634d914846" have entirely different histories.

View file

@ -7,18 +7,12 @@ 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 workflows, the `attach`, `detach`, `has`, and
`new` commands will default to the name of the root directory if used inside
a Git repository.
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.
## 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.
<details>
<summary><h2>Examples</h2></summary>
In their shortest forms, *every* ReMux command is as short or
shorter than its equivalent tmux command:
```sh
@ -49,14 +43,8 @@ remux a -n foo
TMUX='' tmux new-session -t foo
remux n -n foo
# switch
tmux switch-client -t foo
remux s foo
```
</details>
## Dependencies
ReMux depends on [tmux](https://github.com/tmux/tmux).
@ -67,43 +55,34 @@ ReMux depends on [tmux](https://github.com/tmux/tmux).
<details>
<summary>Release Binary</summary>
Copy the compiled binary from the [releases page](https://git.vwolfe.io/valerie/remux/releases)
to a directory in `$PATH`, such as `/usr/bin/`.
Copy the compiled binary from the <a href="https://git.vwolfe.io/valerie/remux/releases">releases page</a>
to a directory in <code>$PATH</code>, such as <code>/usr/bin/</code>.
</details>
<details>
<summary>Compile from Source</summary>
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 <code>cargo build --release</code> and copy
the file from <code>target/release/</code> to a directory in <code>$PATH</code>,
such as <code>/usr/bin/</code>.
</details>
<details>
<summary>makepkg (AUR)</summary>
Clone the [AUR Repository](https://aur.archlinux.org/remux.git) and run the
command `makepkg --install`.
Clone the <a href="https://aur.archlinux.org/remux.git">AUR Repository</a> and
run the command <code>makepkg --install</code>.
</details>
### Package Managers
<details>
<summary>Arch Linux (AUR): <code>remux</code></summary>
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").
Install the package from the <a href="https://aur.archlinux.org/packages/remux"><code>remux</code> AUR Package</a>
using an AUR package manager such as <a href="https://github.com/Morganamilo/paru"><code>paru</code></a>.
</details>
<details>
<summary>Cargo: <code>tmux-remux</code></summary>
Install the package using Cargo with the command `cargo install tmux-remux`.
Install the package using Cargo with the command <code>cargo install tmux-remux</code>.
</details>
## Configuration