(docs): Update README to be a bit nicer

1 files changed, 143 insertions, 0 deletions

diff --git a/sample_configs/default_config.toml b/sample_configs/default_config.toml
new file mode 100644
index 00000000..fb692df7
--- /dev/null
+++ b/sample_configs/default_config.toml
@@ -0,0 +1,143 @@
+
+# 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]
+
+# Whether to display an average cpu entry.
+#avg_cpu = false
+
+# Whether to use dot markers rather than braille.
+#dot_marker = false
+
+# The update rate of the application.
+#rate = 1000
+
+# Whether to put the CPU legend to the left.
+#left_legend = false
+
+# Whether to set CPU% on a process to be based on the total CPU or just current usage.
+#current_usage = false
+
+# Whether to group processes with the same name together by default.
+#group_processes = false
+
+# Whether to make process searching case sensitive by default.
+#case_sensitive = false
+
+# Whether to make process searching look for matching the entire word by default.
+#whole_word = false
+
+# Whether to make process searching use regex by default.
+#regex = false
+
+# Whether to show CPU entries in the legend when they are hidden.
+#show_disabled_data = false
+
+# 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"
+
+# The default time interval (in milliseconds).
+#default_time_value = 60000
+
+# The time delta on each zoom in/out action (in milliseconds).
+#time_delta = 15000
+
+# Override layout default widget
+#default_widget_type = "proc"
+#default_widget_count = 1
+
+# Use basic mode
+#basic = false
+
+##########################################################
+
+# These are all the components that support custom theming.  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.
+[colors]
+
+# Represents the colour of table headers (processes, CPU, disks, temperature).
+#table_header_color="LightBlue"
+
+# Represents the colour of the label each widget has.
+#widget_title_color="Gray"
+
+# Represents the average CPU color.
+#avg_cpu_color="Red"
+
+# Represents the colour the core will use in the CPU legend and graph.
+#cpu_core_colors=["LightMagenta", "LightYellow", "LightCyan", "LightGreen", "LightBlue", "LightRed", "Cyan", "Green", "Blue", "Red"]
+
+# Represents the colour RAM will use in the memory legend and graph.
+#ram_color="LightMagenta"
+
+# Represents the colour SWAP will use in the memory legend and graph.
+#swap_color="LightYellow"
+
+# Represents the colour rx will use in the network legend and graph.
+#rx_color="LightCyan"
+
+# Represents the colour tx will use in the network legend and graph.
+#tx_color="LightGreen"
+
+# Represents the colour of the border of unselected widgets.
+#border_color="Gray"
+
+# Represents the colour of the border of selected widgets.
+#highlighted_border_color="LightBlue"
+
+# Represents the colour of most text.
+#text_color="Gray"
+
+# Represents the colour of text that is selected.
+#selected_text_color="Black"
+
+# Represents the background colour of text that is selected.
+#selected_bg_color="Cyan"
+
+# Represents the colour of the lines and text of the graph.
+#graph_color="Gray"
+
+##########################################################
+
+# Layout - layouts follow a pattern like this:
+# [[row]] represents a row in the application.
+# [[row.child]] represents either a widget or a column.
+# [[row.child.child]] represents a widget.
+#
+# All widgets must have the type value set to one of ["cpu", "mem", "proc", "net", "temp", "disk", "empty"].
+# All layout components have a ratio value - if this is not set, then it defaults to 1. 
+
+# The default widget layout:
+#[[row]]
+# ratio=30
+# [[row.child]]
+# type="cpu"
+#[[row]]
+#   ratio=40
+#   [[row.child]]
+#     ratio=4
+#     type="mem"
+#   [[row.child]]
+#     ratio=3
+#     [[row.child.child]]
+#       type="temp"
+#     [[row.child.child]]
+#       type="disk"
+#[[row]]
+# ratio=30
+# [[row.child]]
+#   type="net"
+# [[row.child]]
+#   type="proc"
+#   default=true