Mirrors/bottom
2
0
Fork 0
mirror of https://github.com/ClementTsang/bottom synced 2024-11-23 04:33:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

(docs): Updates docs and removes a debug

Browse source
This commit is contained in:
Clement Tsang 2020-04-03 01:16:23 -04:00 committed by GitHub
commit 620d614f12
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -14,54 +14,31 @@ This documentation is relevant to version 0.3.0. Please refer to [release branch
## Table of Contents ## Table of Contents
- [Installation](#installation) - [Installation](#installation)
- [Manual](#manual) - [Manual](#manual)
- [Cargo](#cargo) - [Cargo](#cargo)
- [AUR](#aur) - [AUR](#aur)
- [Debian (and Debian-based)](#debian) - [Debian (and Debian-based)](#debian)
- [Homebrew](#homebrew) - [Homebrew](#homebrew)
- [Scoop](#scoop) - [Scoop](#scoop)
- [Chocolatey](#chocolatey) - [Chocolatey](#chocolatey)
- [Usage](#usage) - [Usage](#usage)
- [Flags](#flags) - [Flags](#flags)
- [Options](#options) - [Options](#options)
- [Keybindings](#keybindings) - [Keybindings](#keybindings)
- [General](#general) - [General](#general)
- [CPU bindings](#cpu-bindings) - [CPU bindings](#cpu-bindings)
- [Process bindings](#process-bindings) - [Process bindings](#process-bindings)
- [Process search bindings](#process-search-bindings) - [Process search bindings](#process-search-bindings)
- [Features](#features) - [Features](#features)
- [Process filtering](#process-filtering) - [Process filtering](#process-filtering)
- [Zoom](#zoom) - [Zoom](#zoom)
- [Maximizing](#maximizing) - [Maximizing](#maximizing)
- [Config files](#config-files) - [Config files](#config-files)
- [Config flags](#config-flags) - [Config flags](#config-flags)
- [Theming](#theming) - [Theming](#theming)
- [Layout](#layout) - [Layout](#layout)
- [Compatibility](#compatibility) - [Compatibility](#compatibility)
- [Contribution](#contribution)
- [Contributors](#contributors)
- [Thanks](#thanks) - [Thanks](#thanks)
## Installation ## Installation
@ -70,7 +47,7 @@ Note that binaries are built on the stable version of Rust, and I mainly test an
### Manual ### Manual
Clone from this repo or from [Releases](https://github.com/ClementTsang/bottom/releases), and build with `cargo build --release`. Clone from this repo or from [Releases](https://github.com/ClementTsang/bottom/releases), and build with `cargo build --release`. You may also want to strip the binary after.
### Cargo ### Cargo
@ -158,7 +135,7 @@ Run using `btm`.
#### General #### General
| | | | | |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------- | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `q`, `Ctrl-c` | Quit bottom | | `q`, `Ctrl-c` | Quit bottom |
| `Esc` | Close dialog windows, search, widgets, or exit maximized mode | | `Esc` | Close dialog windows, search, widgets, or exit maximized mode |
| `Ctrl-r` | Reset display and any collected data | | `Ctrl-r` | Reset display and any collected data |
@ -173,7 +150,7 @@ Run using `btm`.
| `+` | Zoom in on a chart | | `+` | Zoom in on a chart |
| `-` | Zoom out on a chart | | `-` | Zoom out on a chart |
| `=` | Reset zoom | | `=` | Reset zoom |
| Mouse scroll | Table: Scrolls through the list Chart: Zooms in or out by scrolling up or down respectively | | Mouse scroll | Table: Scrolls through the list<br>Chart: Zooms in or out by scrolling up or down respectively |
#### CPU bindings #### CPU bindings
@ -183,7 +160,7 @@ Run using `btm`.
| `Space` | Toggle enabled/disabled cores | | `Space` | Toggle enabled/disabled cores |
| `Esc` | Exit filtering mode | | `Esc` | Exit filtering mode |
#### Processes bindings #### Process bindings
| | | | | |
| ------------- | ---------------------------------------------------------- | | ------------- | ---------------------------------------------------------- |
@ -382,13 +359,15 @@ and get the following CPU donut:
### Compatibility ### Compatibility
The current compatibility of widgets with operating systems from personal testing:
| OS | CPU | Memory | Disks | Temperature | Processes/Search | Networks | | OS | CPU | Memory | Disks | Temperature | Processes/Search | Networks |
| ------- | --- | ------ | ----- | ----------- | ---------------- | -------- | | ------- | --- | ------ | ----- | ----------- | ---------------- | -------- |
| Linux | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | Linux | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Windows | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ | | Windows | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ |
| macOS | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | macOS | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
## Contributors ## Contribution
Contribution is always welcome - just submit a PR! Note that I currently develop and test on stable Rust. Contribution is always welcome - just submit a PR! Note that I currently develop and test on stable Rust.

2
src/main.rs
View file

@ -361,8 +361,6 @@ fn create_config(flag_config_location: Option<&str>) -> error::Result<Config> {
OsString::new() OsString::new()
}; };
debug!("Config path: {:?}", config_path);
let path = std::path::Path::new(&config_path); let path = std::path::Path::new(&config_path);
if let Ok(config_string) = fs::read_to_string(path) { if let Ok(config_string) = fs::read_to_string(path) {