diff --git a/README.md b/README.md index fcd78d1a..14557e06 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,7 @@ A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows. Inspired by both [gtop](https://github.com/aksakalli/gtop) and [gotop](https://github.com/cjbassi/gotop). - - -![Quick demo recording showing off searching, expanding, and process killing.](assets/summary_and_search.gif) _Theme based on [gruvbox](https://github.com/morhetz/gruvbox) (see [sample config](./sample_configs/demo_config.toml))._ Recorded on version 0.2.0. +![Quick demo recording showing off searching, expanding, and process killing.](assets/summary_and_search.gif) _Theme based on [gruvbox](https://github.com/morhetz/gruvbox) (see [sample config](./sample_configs/demo_config.toml))._ Recorded on version 0.4.0. **Note**: This documentation is relevant to version 0.4.0 and may refer to in-development or unreleased features, especially if you are reading this on the master branch. Please refer to [release branch](https://github.com/ClementTsang/bottom/tree/release/README.md) or [crates.io](https://crates.io/crates/bottom) for the most up-to-date _release_ documentation. @@ -329,15 +327,17 @@ By default, just typing in something will search by process name: This simple search can be refined by matching by case, matching the entire word, or by using regex: -![a slightly better search](assets/simple_advanced_search.png) +![a slightly better search](assets/regex_search.png) -Now let's say you want to search for two things: luckily, we have the `AND` and `OR` logical operators: +Now let's say you want to search for two things - luckily, we have the `AND` and `OR` logical operators: ![logical operator demo](assets/or_search.png) +![logical operator demo](assets/and_or_search.png) + Furthermore, one is able to refine their searches by CPU usage, memory usage, PID, and more. For example: -![using cpu filter](assets/search_cpu_filter.png) +![using cpu filter](assets/usage_search.png) One can see all available keywords and query options [here](#process-searching-keywords). @@ -470,7 +470,7 @@ Each component of the layout accepts a `ratio` value. If this is not set, it def For an example, look at the [default config](./sample_configs/default_config.toml), which contains the default layout. -...and yes, you can have duplicate widgets. This means you could do something like: +And if your heart desires, you can have duplicate widgets. This means you could do something like: ```toml [[row]] @@ -506,29 +506,7 @@ and get the following CPU donut: You can get battery statistics (charge, time to fill/discharge, consumption in watts, and battery health) via the battery widget. -Since this is only useful for devices like laptops, it is off by default. You can either enable the widget in the default layout via the `--battery` flag, or by specifying the widget in a [layout](#layout). - -So with this slightly silly layout: - -```toml -[[row]] - ratio=1 - [[row.child]] - type="batt" -[[row]] - ratio=2 - [[row.child]] - ratio=4 - type="batt" - [[row.child]] - ratio=3 - [[row.child.child]] - type="cpu" - [[row.child.child]] - type="batt" -``` - -You get this: +Since this is only useful for devices like laptops, it is off by default. You can either enable the widget in the default layout via the `--battery` flag, or by specifying the widget in a [layout](#layout): ![Battery example](assets/battery.png) diff --git a/assets/and_or_search.png b/assets/and_or_search.png new file mode 100644 index 00000000..9498c592 Binary files /dev/null and b/assets/and_or_search.png differ diff --git a/assets/basic_mode.png b/assets/basic_mode.png index 03dd805c..8ca9fd81 100644 Binary files a/assets/basic_mode.png and b/assets/basic_mode.png differ diff --git a/assets/battery.png b/assets/battery.png index 04c3f65b..1bf0a161 100644 Binary files a/assets/battery.png and b/assets/battery.png differ diff --git a/assets/cpu_layout.png b/assets/cpu_layout.png index 99dbf8fb..9db52aaa 100644 Binary files a/assets/cpu_layout.png and b/assets/cpu_layout.png differ diff --git a/assets/quote_search.png b/assets/quote_search.png index a510be5b..fb5619a8 100644 Binary files a/assets/quote_search.png and b/assets/quote_search.png differ diff --git a/assets/regex_search.png b/assets/regex_search.png new file mode 100644 index 00000000..fcb79d16 Binary files /dev/null and b/assets/regex_search.png differ diff --git a/assets/sample_layout.png b/assets/sample_layout.png index 94dc8ace..ba90d754 100644 Binary files a/assets/sample_layout.png and b/assets/sample_layout.png differ diff --git a/assets/search_cpu_filter.png b/assets/search_cpu_filter.png deleted file mode 100644 index dae78fb6..00000000 Binary files a/assets/search_cpu_filter.png and /dev/null differ diff --git a/assets/search_empty.png b/assets/search_empty.png index 7026cf12..1a42edd4 100644 Binary files a/assets/search_empty.png and b/assets/search_empty.png differ diff --git a/assets/simple_advanced_search.png b/assets/simple_advanced_search.png deleted file mode 100644 index e499ce32..00000000 Binary files a/assets/simple_advanced_search.png and /dev/null differ diff --git a/assets/simple_search.png b/assets/simple_search.png index d70bf598..6e7dde8d 100644 Binary files a/assets/simple_search.png and b/assets/simple_search.png differ diff --git a/assets/summary_and_search.gif b/assets/summary_and_search.gif index c2990f58..416a29d0 100644 Binary files a/assets/summary_and_search.gif and b/assets/summary_and_search.gif differ diff --git a/assets/usage_search.png b/assets/usage_search.png new file mode 100644 index 00000000..e9d85ae2 Binary files /dev/null and b/assets/usage_search.png differ diff --git a/sample_configs/demo_config.toml b/sample_configs/demo_config.toml index fa3ce588..f3e035d4 100644 --- a/sample_configs/demo_config.toml +++ b/sample_configs/demo_config.toml @@ -1,10 +1,7 @@ [flags] avg_cpu = true -dot_marker = false # Temperature is one of: -#temperature_type = "k" -#temperature_type = "f" temperature_type = "c" rate = 1000