From debee7d9cbbe6d38b6136e318b5e6f461a6fd4a3 Mon Sep 17 00:00:00 2001 From: ClementTsang Date: Thu, 13 Feb 2020 21:36:49 -0500 Subject: [PATCH] [skip travis] Updated documentation. --- README.md | 50 ++++++++++++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index bc3b6d3e..42cd85f4 100644 --- a/README.md +++ b/README.md @@ -98,36 +98,42 @@ Run using `btm`. - `-R`, `--regex` will default to using regex. +- `--cpu_default`, `--memory_default`, `--disk_default`, `--temperature_default`, `--network_default`, `--process_default` will default the selected widget on startup to that option. By default the process widget is selected. + - `-C`, `--config` takes in a file path leading to a TOML file. - One use of a config file is to set flags to execute by default. +### Config Files - - 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 = ""`. +One use of a config file is to set flags to execute by default. - Another use is to set colours, under the `[colors]`. The following labels are customizable with hex colour code strings: +- This is set under the `[flags]` section. +- These options are generally the same as the long names as other flags (ex: `case_sensitive = true`). +- Note that if a flag and an option conflict, the flag has higher precedence (ex: if the `-c` and `temperature_type = kelvin` both exist, the Celsius temperature type is ultimately chosen). +- For temperature type, use `temperature_type = "kelvin|k|celsius|c|fahrenheit|f"`. +- For default widgets, use `default_widget = "cpu_default|memory_default|disk_default|temperature_default|network_default|process_default"`. - - 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 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"`). - - RX and TX colours (`rx_color="#ffffff"`, `tx_color="#111111"`). - - Widget title colour (`widget_title_color="#ffffff"`). - - General widget border colour (`border_color="#ffffff"`). - - Current widget border colour (`highlighted_border_color="#ffffff"`). - - Text colour (`text_color="#ffffff"`). - - Label and graph colour (`graph_color="#ffffff"`). - - Cursor colour (`cursor_color="#ffffff"`). - - Current selected scroll entry colour (`scroll_entry_text_color="#282828"`, `scroll_entry_bg_color="#458588"`). +Another use is to set colours, under the `[colors]`. The following labels are customizable with hex colour code strings: - bottom will check specific locations by default for a config file. +- 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 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"`). +- RX and TX colours (`rx_color="#ffffff"`, `tx_color="#111111"`). +- Widget title colour (`widget_title_color="#ffffff"`). +- General widget border colour (`border_color="#ffffff"`). +- Current widget border colour (`highlighted_border_color="#ffffff"`). +- Text colour (`text_color="#ffffff"`). +- Label and graph colour (`graph_color="#ffffff"`). +- Cursor colour (`cursor_color="#ffffff"`). +- Current selected scroll entry colour (`scroll_entry_text_color="#282828"`, `scroll_entry_bg_color="#458588"`). - - For Unix-based systems: `~/.config/btm/btm.toml`. - - For Windows: TBD. +bottom will check specific locations by default for a config file. - See this [config](./sample_config.toml) for an example. +- For Unix-based systems: `~/.config/btm/btm.toml`. +- For Windows: TBD. + +See this [config](./sample_config.toml) for an example. ### Keybindings