summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClementTsang <cjhtsang@uwaterloo.ca>2020-02-16 21:12:31 -0500
committerClementTsang <cjhtsang@uwaterloo.ca>2020-02-16 21:12:31 -0500
commitf7ab907b74c4d51c8ab25cdb4cf37792a3c08727 (patch)
tree641c8affb7e833835c68da4185da6f54a2d6fa61 /docs
parente2039722eb8e7eb510923191ab9d88c097ebcd31 (diff)
[skip travis] Update documentation with widget specifics; prepare for release soon...
Diffstat (limited to 'docs')
-rw-r--r--docs/widgets.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/docs/widgets.md b/docs/widgets.md
index 6bc0b240..efe0e433 100644
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -1,3 +1,31 @@
# Widgets
-More information about each widget.
+More information about each widget:
+
+## 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
+
+- If no SWAP is available (size of 0) then no entry will show for SWAP.
+
+## 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 sensors are sorted alphabetically and then by temperature (descending).
+
+- Personally I found this to not work on Windows but YMMV.
+
+## 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
+
+- 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.