diff options
| author | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-04-28 22:46:48 -0400 |
|---|---|---|
| committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-04-28 22:46:48 -0400 |
| commit | 70779c078da7c5c967c3de304cf1a8481da5ea77 (patch) | |
| tree | 492aa7b553c87e7febb1f2da4637adc54cb77304 | |
| parent | 554505b221ae385769f6b5534bf03d5f0f3e8a11 (diff) | |
docs: update help and README for bindings
| -rw-r--r-- | CHANGELOG.md | 6 | ||||
| -rw-r--r-- | README.md | 39 | ||||
| -rw-r--r-- | src/constants.rs | 8 |
3 files changed, 30 insertions, 23 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index ed491f29..fe400143 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,10 +40,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - [#126](https://github.com/ClementTsang/bottom/pull/126): Updated error messages to be a bit more consistent/helpful. -- Redesigned help menu to allow for scrolling. +- [#70](https://github.com/ClementTsang/bottom/issues/70): Redesigned help menu to allow for scrolling. - [#134](https://github.com/ClementTsang/bottom/pull/134): Added `hjkl` movement to delete dialog. +- [#59](https://github.com/ClementTsang/bottom/issues/59): Redesigned search menu and query. + ### Bug Fixes - Fixed `dd` not working on non-first entries. @@ -57,7 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Switch to stateful widget style for tables. -- Updated arg tests and added config testing. +- [#38](https://github.com/ClementTsang/bottom/issues/38): Updated arg tests and added config testing. - More refactoring. @@ -53,7 +53,7 @@ Note that binaries are built on the stable version of Rust, and I mainly test an ### Manual -There are a few ways to go about doing this (note you will need the current version of stable Rust). For example: +There are a few ways to go about doing this (note you may need the current version of stable Rust, as I develop using the most recent version of stable). For example: ```bash # Update Rust on the stable channel @@ -167,23 +167,25 @@ Run using `btm`. #### General -| | | -| -------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `q`, `Ctrl-c` | Quit | -| `Esc` | Close dialog windows, search, widgets, or exit maximized mode | -| `Ctrl-r` | Reset display and any collected data | -| `f` | Freeze/unfreeze updating with new data | -| `Ctrl`-arrow key<br>`Shift`-arrow key<br>`H/J/K/L` | Move to a different widget (on macOS some keybindings may conflict) | -| `Up`,`k` | Scroll up | -| `Down`, `j` | Scroll down | -| `?` | Open help menu | -| `gg`, `Home` | Jump to the first entry | -| `Shift-g`, `End` | Jump to the last entry | -| `Enter` | Maximize the currently selected widget | -| `+` | Zoom in on chart (decrease time range) | -| `-` | Zoom out on chart (increase time range) | -| `=` | Reset zoom | -| Mouse scroll | Table: Scrolls through the list<br>Chart: Zooms in or out by scrolling up or down respectively | +| | | +| -------------------------------------------------- | ---------------------------------------------------------------------------- | +| `q`, `Ctrl-c` | Quit | +| `Esc` | Close dialog windows, search, widgets, or exit maximized mode | +| `Ctrl-r` | Reset display and any collected data | +| `f` | Freeze/unfreeze updating with new data | +| `Ctrl`-arrow key<br>`Shift`-arrow key<br>`H/J/K/L` | Move to a different widget (on macOS some keybindings may conflict) | +| `Left`, `h` | Move left within widget | +| `Down`, `j` | Move down within widget | +| `Up`,`k` | Move up within widget | +| `Right`, `l` | Move right within widget | +| `?` | Open help menu | +| `gg`, `Home` | Jump to the first entry | +| `Shift-g`, `End` | Jump to the last entry | +| `Enter` | Maximize the currently selected widget | +| `+` | Zoom in on chart (decrease time range) | +| `-` | Zoom out on chart (increase time range) | +| `=` | Reset zoom | +| Mouse scroll | Table: Scroll<br>Chart: Zooms in or out by scrolling up or down respectively | #### CPU bindings @@ -478,6 +480,7 @@ Thanks to all contributors ([emoji key](https://allcontributors.org/docs/en/emoj <!-- markdownlint-enable --> <!-- prettier-ignore-end --> + <!-- ALL-CONTRIBUTORS-LIST:END --> ## Bug reports and feature requests diff --git a/src/constants.rs b/src/constants.rs index 7db7f535..a53e532a 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -45,7 +45,7 @@ pub const HELP_CONTENTS_TEXT: [&str; 6] = [ "5 - Battery bindings", ]; -pub const GENERAL_HELP_TEXT: [&str; 18] = [ +pub const GENERAL_HELP_TEXT: [&str; 20] = [ "1 - General bindings\n", "q, Ctrl-c Quit\n", "Esc Close dialog windows, search, widgets, or exit maximized mode\n", @@ -54,8 +54,10 @@ pub const GENERAL_HELP_TEXT: [&str; 18] = [ "Ctrl-Arrow \n", "Shift-Arrow Move to a different widget\n", "H/J/K/L \n", - "Up, k Scroll up\n", - "Down, j Scroll down\n", + "Left, h Move left within widget\n", + "Down, j Move down within widget\n", + "Up, k Move up within widget\n", + "Right, l Move right within widget\n", "? Open help menu\n", "gg Jump to the first entry\n", "G Jump to the last entry\n", |