summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClementTsang <cjhtsang@uwaterloo.ca>2020-02-20 20:13:17 -0500
committerClementTsang <cjhtsang@uwaterloo.ca>2020-02-20 20:13:17 -0500
commit16ad47a85d1ba7531d70a787854be12bf2b0f251 (patch)
treef39a976f9dd3f35a5214a44a462a827990a890ae
parent7f0a05a8f998136a1abf938f1dabc444c5c032cb (diff)
[skip travis] Update docs, add default config file.
-rw-r--r--README.md2
-rw-r--r--btm.toml83
2 files changed, 84 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9be55343..ac44b1d8 100644
--- a/README.md
+++ b/README.md
@@ -56,7 +56,7 @@ I plan to add a Chocolatey install option in the future.
### macOS
-macOS seems to work fine for the most part, barring minor issues with the `Ctrl`-arrow key bindings (use `Shift` instead). I plan to add a Homebrew install option in the future.
+macOS seems to work fine for the most part, barring potential keybind conflicts when trying to switch widgets (`H/J/K/L` seems to have no conflicts). I plan to add a Homebrew install option in the future.
## Usage
diff --git a/btm.toml b/btm.toml
new file mode 100644
index 00000000..0d4df0a8
--- /dev/null
+++ b/btm.toml
@@ -0,0 +1,83 @@
+# This is a default config file for bottom. All of the settings are commented
+# out by default; if you wish to change them uncomment and modify as you see
+# fit.
+
+# This group of options represents a command-line flag/option. Flags explicitly
+# added when running (ie: btm -a) will override this config file if an option
+# is also set here.
+#[flags]
+
+#avg_cpu = true
+#dot_marker = false
+#rate = 1000
+#left_legend = false
+#current_usage = false
+#group_processes = false
+#case_sensitive = false
+#whole_word = true
+#regex = true
+#show_disabled_data = true
+
+# Defaults to Celsius. Temperature is one of:
+#temperature_type = "k"
+#temperature_type = "f"
+#temperature_type = "c"
+#temperature_type = "kelvin"
+#temperature_type = "fahrenheit"
+#temperature_type = "celsius"
+
+# Defaults to processes. Default widget is one of:
+#default_widget = "cpu_default"
+#default_widget = "memory_default"
+#default_widget = "disk_default"
+#default_widget = "temperature_default"
+#default_widget = "network_default"
+#default_widget = "process_default"
+
+
+# These are all the components that support custom theming. Currently, it only
+# supports taking in a string representing a hex colour. Note that colour support
+# will, at the end of the day, depend on terminal support - for example, the
+# macOS default Terminal does NOT like custom colours and it will glitch out.
+#
+# The default options here are based on gruvbox: https://github.com/morhetz/gruvbox
+#[colors]
+
+# Represents the colour of table headers (processes, CPU, disks, temperature).
+#table_header_color="#458588"
+
+# Represents the colour of the label each widget has.
+#widget_title_color="#cc241d"
+
+# Represents the colour the core will use in the CPU legend and graph.
+#cpu_core_colors=["#cc241d", "#98971a"]
+
+# Represents the colour RAM will use in the memory legend and graph.
+#ram_color="#fb4934"
+
+# Represents the colour SWAP will use in the memory legend and graph.
+#swap_color="#fabd2f"
+
+# Represents the colour rx will use in the network legend and graph.
+#rx_color="#458588"
+
+# Represents the colour tx will use in the network legend and graph.
+#tx_color="#689d6a"
+
+# Represents the colour of the border of unselected widgets.
+#border_color="#ebdbb2"
+
+# Represents the colour of the border of selected widgets.
+#highlighted_border_color="#fe8019"
+
+# Represents the colour of the border of most text that is otherwise not covered.
+#text_color="#ebdbb2"
+
+# Represents the colour of text that is selected.
+#selected_text_color="#282828"
+
+# Represents the background colour of text that is selected.
+#selected_bg_color="#458588"
+
+# Represents the colour of the lines and text of the graph.
+#graph_color="#ebdbb2"