mirror of
https://github.com/ClementTsang/bottom.git
synced 2024-09-11 03:35:35 +03:00
[skip travis] Update README with compatibility chart
This commit is contained in:
parent
9ff3cb7a52
commit
4ae2882aa6
4
.markdownlint.json
Normal file
4
.markdownlint.json
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"MD013": false,
|
||||||
|
"MD033": false
|
||||||
|
}
|
28
README.md
28
README.md
@ -20,9 +20,15 @@ You can currently install by cloning and building yourself using `cargo build --
|
|||||||
|
|
||||||
macOS support will hopefully come soon<sup>TM</sup>.
|
macOS support will hopefully come soon<sup>TM</sup>.
|
||||||
|
|
||||||
## Usage
|
The compatibility of each widget and operating systems are, as of version 0.1.0, as follows:
|
||||||
|
|
||||||
Note that all options and keybindings on GitHub may reflect the current development build, and not that of the current releases. For now, refer to the [crate](https://crates.io/crates/bottom) README for documentation as of time of release.
|
| OS/Widget | CPU | Memory | Disks | Temperature | Processes | Networks |
|
||||||
|
| --------- | -------- | -------- | -------- | --------------------- | --------- | --------------------------------------------- |
|
||||||
|
| Linux | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Windows | ✓ | ✓ | ✓ | Currently not working | ✓ | Partially supported (total RX/TX unavailable) |
|
||||||
|
| macOS | Untested | Untested | Untested | Untested | Untested | Untested |
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
### Command line options
|
### Command line options
|
||||||
|
|
||||||
@ -84,23 +90,7 @@ Note that all options and keybindings on GitHub may reflect the current developm
|
|||||||
|
|
||||||
### Mouse actions
|
### Mouse actions
|
||||||
|
|
||||||
[* Scrolling either scrolls through the list if the panel is a table (Temperature, Disks, Processes), or zooms in and out if it is a chart.]: <>
|
- Scrolling with the mouse will go through lists/tables right now, similar to using the up/down arrow keys.
|
||||||
|
|
||||||
- Scrolling currently only scrolls through the list if the panel is a table (Temperature, Disks, Processes).
|
|
||||||
|
|
||||||
## Widget Functionality
|
|
||||||
|
|
||||||
### CPU
|
|
||||||
|
|
||||||
### Memory
|
|
||||||
|
|
||||||
### Sensors
|
|
||||||
|
|
||||||
### Disk
|
|
||||||
|
|
||||||
### Network
|
|
||||||
|
|
||||||
### Processes
|
|
||||||
|
|
||||||
## Thanks, kudos, and all the like
|
## Thanks, kudos, and all the like
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user