tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[skip travis] Update documentation with widget specifics; prepare for release soon...

This commit is contained in:
ClementTsang 2020-02-16 21:12:31 -05:00
parent e2039722eb
commit f7ab907b74
2 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -2,7 +2,7 @@
[![Build Status](https://travis-ci.com/ClementTsang/bottom.svg?token=1wvzVgp94E1TZyPNs8JF&branch=master)](https://travis-ci.com/ClementTsang/bottom) [![crates.io link](https://img.shields.io/crates/v/bottom.svg)](https://crates.io/crates/bottom)
A graphical top clone, written in Rust. Inspired by both [gtop](https://github.com/aksakalli/gtop) and [gotop](https://github.com/cjbassi/gotop).
A graphical top clone, written in Rust. Inspired by both [gtop](https://github.com/aksakalli/gtop) and [gotop](https://github.com/cjbassi/gotop). Supports Linux, macOS, and Windows.
![Quick demo recording](assets/recording_1.gif) _Terminal: Kitty Terminal, Font: IBM Plex Mono, OS: Arch Linux_
@ -10,7 +10,7 @@ A graphical top clone, written in Rust. Inspired by both [gtop](https://github.c
Features of bottom include:
- CPU widget to show a visual representation of per-core usage. Average CPU display also exists.
- CPU widget to show a visual representation of per-core (and optionally average) usage.
- Memory widget to show a visual representation of both RAM and SWAP usage.
@ -24,7 +24,7 @@ Features of bottom include:
- Config file support for custom colours and default options.
- Maximizing of widgets of interest.
- Maximizing of widgets of interest to take up the entire window.
Details about each widget can be found [here](./docs/widgets.md).

30
docs/widgets.md
View File

@ -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.