summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClementTsang <cjhtsang@uwaterloo.ca>2020-04-09 15:28:43 -0400
committerClementTsang <cjhtsang@uwaterloo.ca>2020-04-09 15:28:43 -0400
commit99516ca143b12c785235cd75348d9e362791458e (patch)
tree52d577e66028a5050f448ccd3922007b61f1c545 /docs
parent28c27272d75a97bcfc76a293640358d0d2873764 (diff)
chore: Delete docs folder and update lock
Diffstat (limited to 'docs')
-rw-r--r--docs/config.md82
-rw-r--r--docs/widgets.md57
2 files changed, 0 insertions, 139 deletions
diff --git a/docs/config.md b/docs/config.md
deleted file mode 100644
index d625739a..00000000
--- a/docs/config.md
+++ /dev/null
@@ -1,82 +0,0 @@
-# Config Files
-
-## Boot options
-
-One use of a config file is to set boot flags to execute without having to state them when launching the program.
-
-- 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"`.
-
-## Colours
-
-Another use is to set colours, under the `[colors]`. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.
-
-Supported named colours are one of the following: `Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White`
-
-| Labels | Details | Example |
-| ------------------------------- | ---------------------------------------------- | ------------------------------------------------------ |
-| Table header colours | Colour of table headers | `table_header_color="256, 256, 256"` |
-| CPU colour per core | Colour of each core. Read in order. | `cpu_core_colors=["#ffffff", "blue", "122, 122, 122"]` |
-| Average CPU colour | The average CPU color | `avg_cpu_color="Red"` |
-| RAM | The colour RAM will use | `ram_color="#ffffff"` |
-| SWAP | The colour SWAP will use | `swap_color="#111111"` |
-| RX | The colour rx will use | `rx_color="#ffffff"` |
-| TX | The colour tx will use | `tx_color="#111111"` |
-| Widget title colour | The colour of the label each widget has | `widget_title_color="#ffffff"` |
-| Border colour | The colour of the border of unselected widgets | `border_color="#ffffff"` |
-| Selected border colour | The colour of the border of selected widgets | `highlighted_border_color="#ffffff"` |
-| Text colour | The colour of most text | `text_color="#ffffff"` |
-| Graph colour | The colour of the lines and text of the graph | `graph_color="#ffffff"` |
-| Cursor colour | The cursor's colour | `cursor_color="#ffffff"` |
-| Selected text colour | The colour of text that is selected | `scroll_entry_text_color="#282828"` |
-| Selected text background colour | The background colour of text that is selected | `scroll_entry_bg_color="#458588"` |
-
-Note some colours may not be compatible with the terminal you are using. For example, macOS's default Terminal does not play nice with many colours.
-
-## Layout
-
-As of 0.3.0, bottom supports custom layouts. Layouts are in the TOML specification, and are arranged by row -> column -> row. For example, the default layout:
-
-```toml
-[[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
-```
-
-Valid types are:
-
-- `cpu`
-- `mem`
-- `proc`
-- `net`
-- `temp`
-- `disk`
-- `empty`
-
-## Default config locations
-
-bottom will check specific locations by default for a config file. If no file is found, it will be created.
-
-- For Unix-based systems: `$HOME/.config/bottom/bottom.toml`.
-- For Windows: `{FOLDERID_RoamingAppData}\bottom\bottom.toml` (for example, `C:\Users\Clement\AppData\Roaming\bottom\bottom.toml`).
diff --git a/docs/widgets.md b/docs/widgets.md
deleted file mode 100644
index 7a0d19af..00000000
--- a/docs/widgets.md
+++ /dev/null
@@ -1,57 +0,0 @@
-# Widgets
-
-## Compatibility
-
-The compatibility of each widget and operating systems are, as of version 0.2.0, as follows:
-
-| OS | CPU | Memory | Disks | Temperature | Processes | Networks |
-| ------- | --- | ------ | ----- | ----------- | --------- | -------- |
-| Linux | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
-| Windows | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ |
-| macOS | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
-
-- Linux is tested on Arch Linux, using Kitty Terminal.
-
-- Windows is tested on Windows 10, using Powershell.
-
-- macOS is tested on macOS Catalina, using the base Terminal and Kitty Terminal.
-
-Some notes about each OS:
-
-### Windows
-
-I advise running the program with the `--dot_marker` or `-m` option, as the braille font seems to not work out of the box on Powershell. You may need to install a font like [FreeMono](https://fonts2u.com/free-monospaced.font) and use a terminal like cmder for font support to work properly, unfortunately.
-
-### macOS
-
-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).
-
-## Widget information
-
-### CPU
-
-- Supports displaying specific cores (or average CPU usage if enabled); use `/` to allow for selection of cores to display, and `Space` to enable/disable them.
-
-### Memory
-
-- If no SWAP is available (size of 0) then no entry will show for SWAP.
-
-### Disk
-
-- I'm aware that Windows disk names are a bit strange... not sure if there's much I can do about it.
-
-### Temperature
-
-- Temperature sensors are sorted alphabetically and then by temperature (descending).
-
-- Personally I found this to not work on Windows but YMMV.
-
-### Network
-
-- I'm aware that you cannot easily determine which graph line belongs to which entry unless you maximize - this is due to a limitation of tui-rs, and will be solved in a future release of the library.
-
-- The graph is scaled logarithmically, by bytes, kibibytes, mebibytes, and gibibytes. I personally think this is enough for most people, but if you have a use case in which this isn't enough, let me know and I'll add in ways to increase it.
-
-### Processes
-
-- Filtering follows the convention of VS Code in terms of behaviour. For example, even in regex mode, it is not case sensitive if that is not enabled.