summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClementTsang <clementjhtsang@gmail.com>2020-02-19 22:21:18 -0500
committerClementTsang <clementjhtsang@gmail.com>2020-02-19 22:21:18 -0500
commitc377278974bbf14913ad6bcf996b6c30f1c824e8 (patch)
treeb05a2da8e2931c324a1c4aad26cb1f8fb3ddc25b
parentc4cd43968eac70978a324029904fe0ba0713d9ff (diff)
[skip travis] Update documentation.
-rw-r--r--README.md32
-rw-r--r--src/canvas/canvas_colours/colour_utils.rs3
2 files changed, 18 insertions, 17 deletions
diff --git a/README.md b/README.md
index 917b3aec..b6e3e1bf 100644
--- a/README.md
+++ b/README.md
@@ -108,26 +108,24 @@ See this [config](./sample_config.toml) for an example.
- `q`, `Ctrl-c` to quit. Note if you are currently in the search widget, `q` will not work so you can still type.
+- `Esc` to close a dialog window, widget, or exit maximized mode.
+
- `Ctrl-r` to reset the screen and reset all collected data.
- `f` to freeze the screen from updating with new data. Press `f` again to unfreeze. Note that monitoring will still continue in the background.
-- `Ctrl/Shift`-arrow or `H/J/K/L` to navigate between widgets. **Note that on macOS, `Ctrl`-arrow keys seem to conflict with an existing macOS binding, use `Shift`-arrow key or `H/J/K/L` instead.**
+- `Ctrl/Shift`-arrow or `H/J/K/L` to navigate between widgets. **Note that on macOS, some keybindings may collide with existing ones; `H/J/K/L` should work however.**
-- `Esc` to close a dialog window or exit maximized mode.
+- `Up` or `k` and `Down` or `j` scrolls through the list if the widget is a table (Temperature, Disks, Processes).
- `?` to get a help screen explaining the controls. Note all controls except `Esc` to close the dialog will be disabled while this is open.
-- `Enter` on a widget to maximize the widget.
-
-#### Scrollable tables
-
-- `Up` or `k` and `Down` or `j` scrolls through the list if the widget is a table (Temperature, Disks, Processes).
-
- `gg` or `Home` to jump to the first entry of the current table.
- `G` (`Shift-g`) or `End` to jump to the last entry of the current table.
+- `Enter` on a widget to maximize the widget.
+
#### CPU
- `/` to allow for enabling/disabling showing certain cores with `Space`.
@@ -152,23 +150,23 @@ See this [config](./sample_config.toml) for an example.
- `Tab` to switch between searching for PID and name respectively.
-- `Alt-c` to toggle ignoring case.
+- `Esc` to close.
-- `Alt-m` to toggle matching the entire word.
+- `Ctrl-a` and `Ctrl-e` to jump to the start and end of the search bar respectively.
-- `Alt-r` to toggle using regex.
+- `Ctrl-u` to clear the current search query.
-- `Ctrl-a` and `Ctrl-e` to jump to the start and end of the search bar respectively.
+* `Backspace` to delete one character behind the current cursor position.
-- `Left` and `Right` arrow keys to move the cursor within the search bar.
+* `Delete` to delete one character at the current cursor position.
-- `Ctrl-u` to clear the current search query.
+* `Left` and `Right` arrow keys to move the cursor within the search bar.
-- `Backspace` to delete one character behind the current cursor position.
+- `Alt-c` to toggle ignoring case.
-- `Delete` to delete one character at the current cursor position.
+- `Alt-m` to toggle matching the entire word.
-- `Esc` to close.
+- `Alt-r` to toggle using regex.
Note that `q` is disabled while in the search widget.
diff --git a/src/canvas/canvas_colours/colour_utils.rs b/src/canvas/canvas_colours/colour_utils.rs
index a3bc7023..10ae2857 100644
--- a/src/canvas/canvas_colours/colour_utils.rs
+++ b/src/canvas/canvas_colours/colour_utils.rs
@@ -31,6 +31,9 @@ pub fn gen_n_styles(num_to_gen: i32) -> Vec<Style> {
}
// Generate colours
+ // Why do we need so many colours? Because macOS default terminal
+ // throws a tantrum if you don't give it supported colours, but so
+ // does PowerShell with some colours (Magenta and Yellow)!
let mut colour_vec: Vec<Style> = vec![
Style::default().fg(Color::LightMagenta),
Style::default().fg(Color::LightYellow),