tyler.durden/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2025-07-22 13:14:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

[skip travis] Update README

Browse Source
This commit is contained in:
ClementTsang 2020-02-08 14:38:16 -05:00
parent 2123becb81
commit 13d3e76dc6
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -96,18 +96,23 @@ Run using `btm`.
One use of a config file is to set flags to execute by default. One use of a config file is to set flags to execute by default.
- Options are generally the same as the long names as other flags (ex: `case_sensitive = true`). - This is set under the `[flags]` section.
- These options are generally the same as the long names as other flags (ex: `case_sensitive = true`).
- For temperature type, use `temperature_type = "<kelvin|k|celsius|c|fahrenheit|f>"`. - For temperature type, use `temperature_type = "<kelvin|k|celsius|c|fahrenheit|f>"`.
Another use is to set colours (by default they're somewhat randomly generated). The following labels are customizable with a hex colour code strings: Another use is to set colours, under the `[colors]`. The following labels are customizable with hex colour code strings:
- Table header colours (`table_header_color="#ffffff"`). - Table header colours (`table_header_color="#ffffff"`).
- Every CPU core colour as an array (`cpu_core_colors=["#ffffff", "#000000", "#111111"]`). bottom will look at 216 (let's be realistic here) colours at most, and in order. If not enough colours are provided, then the rest will be pseudo-randomly generated. - Every CPU core colour as an array (`cpu_core_colors=["#ffffff", "#000000", "#111111"]`).
- bottom will look at 216 (let's be realistic here) colours at most, and in order.
- If not enough colours are provided for the number of threads on the CPU, then the rest will be automatically generated.
- RAM and SWAP colours (`ram_color="#ffffff"`, `swap_color="#111111"`). - RAM and SWAP colours (`ram_color="#ffffff"`, `swap_color="#111111"`).
- RX and TX colours (`rx_color="#ffffff"`, `tx_color="#111111"`). - RX and TX colours (`rx_color="#ffffff"`, `tx_color="#111111"`).
- Widget title colour (`widget_title_color="#ffffff"`).
- General widget border colour (`border_color="#ffffff"`). - General widget border colour (`border_color="#ffffff"`).
- Current widget border colour (`highlighted_border_color="#ffffff"`). - Current widget border colour (`highlighted_border_color="#ffffff"`).
- Text colour (`text_color="#ffffff"`). - Text colour (`text_color="#ffffff"`).
- Label and graph colour (`graph_color="#ffffff"`).
- Cursor colour (`cursor_color="#ffffff"`). - Cursor colour (`cursor_color="#ffffff"`).
- Current selected scroll entry colour (`scroll_entry_text_color="#282828"`, `scroll_entry_bg_color="#458588"`). - Current selected scroll entry colour (`scroll_entry_text_color="#282828"`, `scroll_entry_bg_color="#458588"`).
@ -116,7 +121,7 @@ Run using `btm`.
- For Unix-based systems: `~/.config/btm/btm.toml`. - For Unix-based systems: `~/.config/btm/btm.toml`.
- For Windows: TBD. - For Windows: TBD.
See the [sample config](./sample_config.toml) for an example. See this [config](./sample_config.toml) for an example.
### Keybindings ### Keybindings