ClementTsang/bottom
1
1
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2024-09-22 00:47:23 +03:00
Code Issues Projects Releases Wiki Activity

docs: Be more clear about versions and details

Browse Source
This commit is contained in:
ClementTsang 2020-04-12 00:19:27 -04:00
parent a351f05d4a
commit ac8dabb2af
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -9,7 +9,7 @@ A cross-platform graphical process/system monitor with a customizable interface
![Quick demo recording showing off searching, maximizing, 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.
This documentation is relevant to version 0.3.0. 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_ version.
**Note**: This documentation is relevant to version 0.4.0 and may refer to in-development 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.
## Table of Contents
@ -40,15 +40,16 @@ This documentation is relevant to version 0.3.0. Please refer to [release branch
- [Layout](#layout)
- [Compatibility](#compatibility)
- [Contribution](#contribution)
- [Bug reports and feature requests](#bug-reports-and-feature-requests)
- [Thanks](#thanks)
## Installation
Note that binaries are built on the stable version of Rust, and I mainly test and release for 64-bit.
Note that binaries are built on the stable version of Rust, and I mainly test and release for 64-bit. As such, support beyond these is not guaranteed.
### Manual
A few ways to go about doing this:
There are a few ways to go about doing this:
```bash
# Clone and install all via Cargo
@ -231,7 +232,7 @@ searching by PID and by process name.
### Zoom
Using the `+`/`-` keys or the scroll wheel will move adjust the current time intervals of the currently selected widget.
Using the `+`/`-` keys or the scroll wheel will move adjust the current time intervals of the currently selected widget, and `=` to reset the zoom levels to the default.
Widgets can hold different time intervals independently. These time intervals can be adjusted using the
`-t`/`--default_time_value` and `-d`/`--time_delta` options, or their corresponding config options.
@ -417,6 +418,11 @@ Thanks to all contributors ([emoji key](https://allcontributors.org/docs/en/emoj
<!-- ALL-CONTRIBUTORS-LIST:END -->
## Bug reports and feature requests
Feel free to submit feature ideas and bug reports on [GitHub](https://github.com/ClementTsang/bottom/issues).
Please try to follow the given issue templates.
## Thanks
- This project is very much inspired by both