From b9c31c22519f3fe879d3b6a14c40197e0507ba60 Mon Sep 17 00:00:00 2001 From: tforgione Date: Mon, 6 Nov 2023 11:36:34 +0100 Subject: [PATCH] Update README.md --- README.md | 123 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 64 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index c43ebdc..ce94120 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,64 @@ -# multiview-rs - -*Run many commands and watch all outputs in a single terminal* - - -## Installation - -If rust is not already installed, [install rust](https://www.rust-lang.org/tools/install). - -Then run: - -```sh -cargo install --git https://gitea.tforgione.fr/tforgione/multiview -``` - -## Usage - -Split your terminal in two rows, the first containing three columns, and the second containing one column: -```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 cmd1 // cmd2 // cmd3 :: cmd4 // cmd5 -``` - -## Colors - -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). - -```sh -multiview unbuffer cmd1 :: unbuffer cmd2 -``` - -## Shortcuts - - - `k`: kills the current tile - - `K`: kills all tiles - - `r`: restarts the current tile - - `R`: restarts all tiles - - `l`: draw a line on the current tile - - `L`: draw a line on all tiles - - `q`: quits - -## Limitations - -*Don't resize your terminal... just don't* :cry: - -## History - -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 - - +# multiview-rs + +*Run many commands and watch all outputs in a single terminal* + +![multiview preview](/screenshots/row-major.png) + +## Installation + +If rust is not already installed, [install rust](https://www.rust-lang.org/tools/install). + +Then run: + +```sh +cargo install --git https://gitea.tforgione.fr/tforgione/multiview +``` + +## Usage + +Split your terminal in two rows, the first containing three columns, and the second containing one column: +```sh +multiview cmd1 :: cmd2 :: cmd3 // cmd4 :: cmd5 +``` + +![multiview row major preview](/screenshots/row-major.png) + +Split your terminal in two columns, the first containing three rows, and the second containing one row: +```sh +multiview cmd1 // cmd2 // cmd3 :: cmd4 // cmd5 +``` + +![multiview col major preview](/screenshots/col-major.png) + +## Colors + +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). + +```sh +multiview unbuffer cmd1 :: unbuffer cmd2 +``` + +## Shortcuts + + - `k`: kills the current tile + - `K`: kills all tiles + - `r`: restarts the current tile + - `R`: restarts all tiles + - `l`: draw a line on the current tile + - `L`: draw a line on all tiles + - `q`: quits + +## Limitations + +*Don't resize your terminal... just don't* :cry: + +## History + +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 + +