Update README.md
This commit is contained in:
parent
dc950ad0d4
commit
b9c31c2251
123
README.md
123
README.md
|
@ -1,59 +1,64 @@
|
||||||
# multiview-rs
|
# multiview-rs
|
||||||
|
|
||||||
*Run many commands and watch all outputs in a single terminal*
|
*Run many commands and watch all outputs in a single terminal*
|
||||||
|
|
||||||
|
![multiview preview](/screenshots/row-major.png)
|
||||||
## Installation
|
|
||||||
|
## Installation
|
||||||
If rust is not already installed, [install rust](https://www.rust-lang.org/tools/install).
|
|
||||||
|
If rust is not already installed, [install rust](https://www.rust-lang.org/tools/install).
|
||||||
Then run:
|
|
||||||
|
Then run:
|
||||||
```sh
|
|
||||||
cargo install --git https://gitea.tforgione.fr/tforgione/multiview
|
```sh
|
||||||
```
|
cargo install --git https://gitea.tforgione.fr/tforgione/multiview
|
||||||
|
```
|
||||||
## Usage
|
|
||||||
|
## Usage
|
||||||
Split your terminal in two rows, the first containing three columns, and the second containing one column:
|
|
||||||
```sh
|
Split your terminal in two rows, the first containing three columns, and the second containing one column:
|
||||||
multiview cmd1 :: cmd2 :: cmd3 // cmd4 :: cmd5
|
```sh
|
||||||
```
|
multiview cmd1 :: cmd2 :: cmd3 // cmd4 :: cmd5
|
||||||
|
```
|
||||||
Split your terminal in two columns, the first containing three rows, and the second containing one row:
|
|
||||||
```sh
|
![multiview row major preview](/screenshots/row-major.png)
|
||||||
multiview cmd1 // cmd2 // cmd3 :: cmd4 // cmd5
|
|
||||||
```
|
Split your terminal in two columns, the first containing three rows, and the second containing one row:
|
||||||
|
```sh
|
||||||
## Colors
|
multiview cmd1 // cmd2 // cmd3 :: cmd4 // cmd5
|
||||||
|
```
|
||||||
Most well written programs will disable colors when running from multiview, in order to force them to use colors, you
|
|
||||||
can use the `unbuffer` command from the [`expect` package](https://packages.ubuntu.com/search?keywords=expect).
|
![multiview col major preview](/screenshots/col-major.png)
|
||||||
|
|
||||||
```sh
|
## Colors
|
||||||
multiview unbuffer cmd1 :: unbuffer cmd2
|
|
||||||
```
|
Most well written programs will disable colors when running from multiview, in order to force them to use colors, you
|
||||||
|
can use the `unbuffer` command from the [`expect` package](https://packages.ubuntu.com/search?keywords=expect).
|
||||||
## Shortcuts
|
|
||||||
|
```sh
|
||||||
- `k`: kills the current tile
|
multiview unbuffer cmd1 :: unbuffer cmd2
|
||||||
- `K`: kills all tiles
|
```
|
||||||
- `r`: restarts the current tile
|
|
||||||
- `R`: restarts all tiles
|
## Shortcuts
|
||||||
- `l`: draw a line on the current tile
|
|
||||||
- `L`: draw a line on all tiles
|
- `k`: kills the current tile
|
||||||
- `q`: quits
|
- `K`: kills all tiles
|
||||||
|
- `r`: restarts the current tile
|
||||||
## Limitations
|
- `R`: restarts all tiles
|
||||||
|
- `l`: draw a line on the current tile
|
||||||
*Don't resize your terminal... just don't* :cry:
|
- `L`: draw a line on all tiles
|
||||||
|
- `q`: quits
|
||||||
## History
|
|
||||||
|
## Limitations
|
||||||
This is my attempt to rewrite [arjunmehta's multiview](https://github.com/arjunmehta/multiview) in rust.
|
|
||||||
|
*Don't resize your terminal... just don't* :cry:
|
||||||
Their version has many features that I don't use, but is missing a few things that I need:
|
|
||||||
- line wrapping: when a line is bigger than the terminal size, the end is just not displayed
|
## History
|
||||||
- scroll: if your output has more lines than your terminal height, there is no way (to my knowledge) to scroll up
|
|
||||||
|
This is my attempt to rewrite [arjunmehta's multiview](https://github.com/arjunmehta/multiview) in rust.
|
||||||
|
|
||||||
|
Their version has many features that I don't use, but is missing a few things that I need:
|
||||||
|
- line wrapping: when a line is bigger than the terminal size, the end is just not displayed
|
||||||
|
- scroll: if your output has more lines than your terminal height, there is no way (to my knowledge) to scroll up
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue