diff --git a/README.md b/README.md index 12b02d28..7abc3366 100644 --- a/README.md +++ b/README.md @@ -96,18 +96,23 @@ Run using `btm`. 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 = ""`. - 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"`). - - 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"`). - 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"`). @@ -116,7 +121,7 @@ Run using `btm`. - For Unix-based systems: `~/.config/btm/btm.toml`. - For Windows: TBD. - See the [sample config](./sample_config.toml) for an example. + See this [config](./sample_config.toml) for an example. ### Keybindings