From 3824b22a509b56e4898bd9fabcf9e4f4ff13d057 Mon Sep 17 00:00:00 2001 From: ClementTsang Date: Wed, 19 Feb 2020 21:32:47 -0500 Subject: [skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. --- docs/config.md | 2 ++ docs/widgets.md | 30 +++++++++++++++++++++++------- 2 files changed, 25 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/config.md b/docs/config.md index b6b76553..dfeb84f0 100644 --- a/docs/config.md +++ b/docs/config.md @@ -28,6 +28,8 @@ Another use is to set colours, under the `[colors]`. The following labels are cu - Cursor colour (`cursor_color="#ffffff"`). - Current selected scroll entry colour (`scroll_entry_text_color="#282828"`, `scroll_entry_bg_color="#458588"`). +Note some colours may not be compatible with the terminal you are using. + ## Default Locations bottom will check specific locations by default for a config file. diff --git a/docs/widgets.md b/docs/widgets.md index efe0e433..48f2a9a9 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -1,31 +1,47 @@ # Widgets -More information about each widget: +## Compatibility -## CPU +The compatibility of each widget and operating systems are, as of version 0.2.0, as follows: + +| OS | CPU | Memory | Disks | Temperature | Processes | Networks | +| ------- | --- | ------ | ----- | ----------- | --------- | -------- | +| Linux | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| Windows | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ | +| macOS | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | + +- Linux is tested on Arch Linux, using Kitty Terminal. + +- Windows is tested on Windows 10, using Powershell. + +- macOS is tested on macOS Catalina, using the base Terminal and Kitty Terminal. + +## Widget Information + +### CPU - Supports displaying specific cores (or average CPU usage if enabled); use `/` to allow for selection of cores to display, and `Space` to enable/disable them. -## Memory +### Memory - If no SWAP is available (size of 0) then no entry will show for SWAP. -## Disk +### Disk - I'm aware that Windows disk names are a bit strange... not sure if there's much I can do about it. -## Temperature +### Temperature - Temperature sensors are sorted alphabetically and then by temperature (descending). - Personally I found this to not work on Windows but YMMV. -## Network +### Network - I'm aware that you cannot easily determine which graph line belongs to which entry unless you maximize - this is due to a limitation of tui-rs, and will be solved in a future release of the library. - The graph is scaled logarithmically, by bytes, kibibytes, mebibytes, and gibibytes. I personally think this is enough for most people, but if you have a use case in which this isn't enough, let me know and I'll add in ways to increase it. -## Processes +### Processes - Filtering follows the convention of VS Code in terms of behaviour. For example, even in regex mode, it is not case sensitive if that is not enabled. -- cgit v1.2.3