diff options
Diffstat (limited to 'docs/content')
17 files changed, 208 insertions, 131 deletions
diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md deleted file mode 100644 index e2ab53ae..00000000 --- a/docs/content/configuration/command-line-flags.md +++ /dev/null @@ -1,47 +0,0 @@ -# Command-line Flags - -The following flags can be provided to bottom in the command line to change the behaviour of the program. You can also -see information on these flags by running `btm -h`, or run `btm --help` to display more detailed information on each flag: - -| Flag | Behaviour | -| ----------------------------------- | --------------------------------------------------------------------- | -| --autohide_time | Temporarily shows the time scale in graphs. | -| -b, --basic | Hides graphs and uses a more basic look. | -| --battery | Shows the battery widget. | -| -S, --case_sensitive | Enables case sensitivity by default. | -| -c, --celsius | Sets the temperature type to Celsius. | -| --color <COLOR SCHEME> | Use a color scheme, use --help for info. | -| -C, --config <CONFIG PATH> | Sets the location of the config file. | -| -u, --current_usage | Sets process CPU% to be based on current CPU%. | -| -t, --default_time_value <TIME> | Default time value for graphs. | -| --default_widget_count <INT> | Sets the n'th selected widget type as the default. | -| --default_widget_type <WIDGET TYPE> | Sets the default widget type, use --help for info. | -| --disable_advanced_kill | Hides advanced process killing. | -| --disable_click | Disables mouse clicks. | -| -m, --dot_marker | Uses a dot marker for graphs. | -| --enable_cache_memory | Enable collecting and displaying cache and buffer memory. | -| --enable_gpu | Enable collecting and displaying GPU usage. | -| -e, --expanded | Expand the default widget upon starting the app. | -| -f, --fahrenheit | Sets the temperature type to Fahrenheit. | -| -g, --group_processes | Groups processes with the same name by default. | -| -a, --hide_avg_cpu | Hides the average CPU usage. | -| --hide_table_gap | Hides spacing between table headers and entries. | -| --hide_time | Hides the time scale. | -| -k, --kelvin | Sets the temperature type to Kelvin. | -| -l, --left_legend | Puts the CPU chart legend to the left side. | -| --mem_as_value | Defaults to showing process memory usage by value. | -| --network_use_binary_prefix | Displays the network widget with binary prefixes. | -| --network_use_bytes | Displays the network widget using bytes. | -| --network_use_log | Displays the network widget with a log scale. | -| --process_command | Show processes as their commands by default. | -| -r, --rate <TIME> | Sets the data refresh rate. | -| -R, --regex | Enables regex by default. | -| --retention <TIME> | The timespan of data stored. | -| --show_table_scroll_position | Shows the scroll position tracker in table widgets. | -| -d, --time_delta <TIME> | The amount of time changed upon zooming. | -| -T, --tree | Defaults the process widget be in tree mode. | -| -n, --unnormalized_cpu | Show process CPU% usage without normalizing over the number of cores. | -| --use_old_network_legend | DEPRECATED - uses a separate network legend. | -| -V, --version | Prints version information. | -| -W, --whole_word | Enables whole-word matching by default. | -| -h, --help | Print help (see more with '--help') | diff --git a/docs/content/configuration/command-line-options.md b/docs/content/configuration/command-line-options.md new file mode 100644 index 00000000..9d95fc96 --- /dev/null +++ b/docs/content/configuration/command-line-options.md @@ -0,0 +1,96 @@ +# Command-line Options + +The following options can be provided to bottom in the command line to change the behaviour of the program. You can also +see information on these options by running `btm -h`, or run `btm --help` to display more detailed information on each option: + +## General Options + +| Option | Behaviour | +| --------------------------------- | ---------------------------------------------------- | +| `--autohide_time` | Temporarily shows the time scale in graphs. | +| `-b, --basic` | Hides graphs and uses a more basic look. | +| `-C, --config <CONFIG PATH>` | Sets the location of the config file. | +| `-t, --default_time_value <TIME>` | Default time value for graphs. | +| `--default_widget_count <N>` | Sets the N'th selected widget type as the default. | +| `--default_widget_type <WIDGET>` | Sets the default widget type, use `--help` for info. | +| `--disable_click` | Disables mouse clicks. | +| `-m, --dot_marker` | Uses a dot marker for graphs. | +| `-e, --expanded` | Expand the default widget upon starting the app. | +| `--hide_table_gap` | Hides spacing between table headers and entries. | +| `--hide_time` | Hides the time scale from being shown. | +| `-r, --rate <TIME>` | Sets how often data is refreshed. | +| `--retention <TIME>` | How far back data will be stored up to. | +| `--show_table_scroll_position` | Shows the scroll position tracker in table widgets. | +| `-d, --time_delta <TIME>` | The amount of time changed upon zooming. | + +## Process Options + +| Option | Behaviour | +| ------------------------- | -------------------------------------------------------------------------------------- | +| `-S, --case_sensitive` | Enables case sensitivity by default. | +| `-u, --current_usage` | Calculates process CPU usage as a percentage of current usage rather than total usage. | +| `--disable_advanced_kill` | Hides additional stopping options Unix-like systems. | +| `-g, --group_processes` | Groups processes with the same name by default. | +| `--mem_as_value` | Defaults to showing process memory usage by value. | +| `--process_command` | Shows the full command name instead of the process name by default. | +| `-R, --regex` | Enables regex by default while searching. | +| `-T, --tree` | Makes the process widget use tree mode by default. | +| `-n, --unnormalized_cpu` | Show process CPU% usage without averaging over the number of CPU cores. | +| `-W, --whole_word` | Enables whole-word matching by default while searching. | + +## Temperature Options + +| Option | Behaviour | +| ------------------ | --------------------------------------------- | +| `-c, --celsius` | Use Celsius as the temperature unit. Default. | +| `-f, --fahrenheit` | Use Fahrenheit as the temperature unit. | +| `-k, --kelvin` | Use Kelvin as the temperature unit. | + +## CPU Options + +| Option | Behaviour | +| -------------------- | ------------------------------------------- | +| `--cpu_left_legend` | Puts the CPU chart legend on the left side. | +| `-a, --hide_avg_cpu` | Hides the average CPU usage entry. | + +## Memory Options + +| Option | Behaviour | +| ---------------------------- | --------------------------------------------------------- | +| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory. | +| `--memory_legend <POSITION>` | Where to place the legend for the memory chart widget. | + +## Network Options + +| Option | Behaviour | +| ----------------------------- | ------------------------------------------------------- | +| `--network_legend <POSITION>` | Where to place the legend for the network chart widget. | +| `--network_use_binary_prefix` | Displays the network widget with binary prefixes. | +| `--network_use_bytes` | Displays the network widget using bytes. | +| `--network_use_log` | Displays the network widget with a log scale. | +| `--use_old_network_legend` | (DEPRECATED) Uses a separated network legend. | + +## Battery Options + +| Option | Behaviour | +| ----------- | ----------------------------------------------- | +| `--battery` | Shows the battery widget in non-custom layouts. | + +## GPU Options + +| Option | Behaviour | +| -------------- | ------------------------------------------- | +| `--enable_gpu` | Enable collecting and displaying GPU usage. | + +## Style Options + +| Option | Behaviour | +| ------------------------ | ------------------------------------------ | +| `--color <COLOR SCHEME>` | Use a color scheme, use `--help` for info. | + +## Other Options + +| Option | Behaviour | +| ----------------- | ------------------------------------------------- | +| `-h`, `--help` | Prints help info (for more details use `--help`.) | +| `-V`, `--version` | Prints version information. | diff --git a/docs/content/configuration/config-file/cpu.md b/docs/content/configuration/config-file/cpu.md new file mode 100644 index 00000000..77d8fe30 --- /dev/null +++ b/docs/content/configuration/config-file/cpu.md @@ -0,0 +1,11 @@ +# CPU + +## Default CPU Graph Selection + +You can configure which CPU graph is shown by default when starting up bottom by setting `cpu.default`. + +```toml +[cpu] +# One of "all" (default), "average"/"avg" +default = "average" +``` diff --git a/docs/content/configuration/config-file/flags.md b/docs/content/configuration/config-file/flags.md index ed9d0aef..4b6792cb 100644 --- a/docs/content/configuration/config-file/flags.md +++ b/docs/content/configuration/config-file/flags.md @@ -4,41 +4,50 @@ This section is in progress, and is just copied from the old documentation. -Most of the [command line flags](../command-line-flags.md) have config file equivalents to avoid having to type them out +You can configure flags by putting them in `[flags]` table. Example: + +```toml +[flags] +color = "nord-light" +``` + +Most of the [command line flags](../command-line-options.md) have config file equivalents to avoid having to type them out each time: -| Field | Type | Functionality | -| ---------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| `hide_avg_cpu` | Boolean | Hides the average CPU usage. | -| `dot_marker` | Boolean | Uses a dot marker for graphs. | -| `left_legend` | Boolean | Puts the CPU chart legend to the left side. | -| `current_usage` | Boolean | Sets process CPU% to be based on current CPU%. | -| `group_processes` | Boolean | Groups processes with the same name by default. | -| `case_sensitive` | Boolean | Enables case sensitivity by default. | -| `whole_word` | Boolean | Enables whole-word matching by default. | -| `regex` | Boolean | Enables regex by default. | -| `basic` | Boolean | Hides graphs and uses a more basic look. | -| `use_old_network_legend` | Boolean | DEPRECATED - uses the older network legend. | -| `battery` | Boolean | Shows the battery widget. | -| `rate` | Unsigned Int (represents milliseconds) or String (represents human time) | Sets a refresh rate in ms. | -| `default_time_value` | Unsigned Int (represents milliseconds) or String (represents human time) | Default time value for graphs in ms. | -| `time_delta` | Unsigned Int (represents milliseconds) or String (represents human time) | The amount in ms changed upon zooming. | -| `hide_time` | Boolean | Hides the time scale. | -| `temperature_type` | String (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"]) | Sets the temperature unit type. | -| `default_widget_type` | String (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options) | Sets the default widget type, use --help for more info. | -| `default_widget_count` | Unsigned Int (represents which `default_widget_type`) | Sets the n'th selected widget type as the default. | -| `disable_click` | Boolean | Disables mouse clicks. | -| `color` | String (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"]) | Use a color scheme, use --help for supported values. | -| `enable_cache_memory` | Boolean | Enable collecting and displaying cache and buffer memory (not available on Windows). | -| `mem_as_value` | Boolean | Defaults to showing process memory usage by value. | -| `tree` | Boolean | Defaults to showing the process widget in tree mode. | -| `show_table_scroll_position` | Boolean | Shows the scroll position tracker in table widgets. | -| `process_command` | Boolean | Show processes as their commands by default. | -| `disable_advanced_kill` | Boolean | Hides advanced options to stop a process on Unix-like systems. | -| `network_use_binary_prefix` | Boolean | Displays the network widget with binary prefixes. | -| `network_use_bytes` | Boolean | Displays the network widget using bytes. | -| `network_use_log` | Boolean | Displays the network widget with a log scale. | -| `enable_gpu` | Boolean | Shows the GPU widgets. | -| `retention` | String (human readable time, such as "10m", "1h", etc.) | How much data is stored at once in terms of time. | -| `unnormalized_cpu` | Boolean | Show process CPU% without normalizing over the number of cores. | -| `expanded_on_startup` | Boolean | Expand the default widget upon starting the app. | +| Field | Type | Functionality | +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | +| `hide_avg_cpu` | Boolean | Hides the average CPU usage. | +| `dot_marker` | Boolean | Uses a dot marker for graphs. | +| `cpu_left_legend` | Boolean | Puts the CPU chart legend to the left side. | +| `current_usage` | Boolean | Sets process CPU% to be based on current CPU%. | +| `group_processes` | Boolean | Groups processes with the same name by default. | +| `case_sensitive` | Boolean | Enables case sensitivity by default. | +| `whole_word` | Boolean | Enables whole-word matching by default. | +| `regex` | Boolean | Enables regex by default. | +| `basic` | Boolean | Hides graphs and uses a more basic look. | +| `use_old_network_legend` | Boolean | DEPRECATED - uses the older network legend. | +| `battery` | Boolean | Shows the battery widget. | +| `rate` | Unsigned Int (represents milliseconds) or String (represents human time) | Sets a refresh rate in ms. | +| `default_time_value` | Unsigned Int (represents milliseconds) or String (represents human time) | Default time value for graphs in ms. | +| `time_delta` | Unsigned Int (represents milliseconds) or String (represents human time) | The amount in ms changed upon zooming. | +| `hide_time` | Boolean | Hides the time scale. | +| `temperature_type` | String (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"]) | Sets the temperature unit type. | +| `default_widget_type` | String (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options) | Sets the default widget type, use --help for more info. | +| `default_widget_count` | Unsigned Int (represents which `default_widget_type`) | Sets the n'th selected widget type as the default. | +| `disable_click` | Boolean | Disables mouse clicks. | +| `color` | String (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"]) | Use a color scheme, use --help for supported values. | +| `enable_cache_memory` | Boolean | Enable cache and buffer memory stats (not available on Windows). | +| `mem_as_value` | Boolean | Defaults to showing process memory usage by value. | +| `tree` | Boolean | Defaults to showing the process widget in tree mode. | +| `show_table_scroll_position` | Boolean | Shows the scroll position tracker in table widgets. | +| `process_command` | Boolean | Show processes as their commands by default. | +| `disable_advanced_kill` | Boolean | Hides advanced options to stop a process on Unix-like systems. | +| `network_use_binary_prefix` | Boolean | Displays the network widget with binary prefixes. | +| `network_use_bytes` | Boolean | Displays the network widget using bytes. | +| `network_use_log` | Boolean | Displays the network widget with a log scale. | +| `enable_gpu` | Boolean | Shows the GPU widgets. | +| `retention` | String (human readable time, such as "10m", "1h", etc.) | How much data is stored at once in terms of time. | +| `unnormalized_cpu` | Boolean | Show process CPU% without normalizing over the number of cores. | +| `expanded` | Boolean | Expand the default widget upon starting the app. | +| `memory_legend` | String (one of ["none", "top-left", "top", "top-right", "left", "right", "bottom-left", "bottom", "bottom-right"]) | Where to place the legend for the memory widget. | +| `network_legend` | String (one of ["none", "top-left", "top", "top-right", "left", "right", "bottom-left", "bottom", "bottom-right"]) | Where to place the legend for the network widget. | diff --git a/docs/content/configuration/config-file/default-config.md b/docs/content/configuration/config-file/index.md index 85fb3f42..8ccf31f4 100644 --- a/docs/content/configuration/config-file/default-config.md +++ b/docs/content/configuration/config-file/index.md @@ -1,6 +1,10 @@ -# Default Config +# Config File -A default config file is automatically generated at the following locations that bottom checks by default: +For persistent configuration, and for certain configuration options, bottom supports config files. + +## Default Config File + +If no config file argument is given, it will automatically look for a config file at these locations: | OS | Default Config Location | | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | @@ -8,4 +12,10 @@ A default config file is automatically generated at the following locations that | Linux | `~/.config/bottom/bottom.toml` <br/> `$XDG_CONFIG_HOME/bottom/bottom.toml` | | Windows | `C:\Users\<USER>\AppData\Roaming\bottom\bottom.toml` | -Furthermore, if a custom config path that does not exist is given (using `-C` or `--config`), bottom will attempt to create a default config file at that location. +Like if a path is passed with `-C`/`--config`, if a file doesn't exist at the path, bottom will automatically create a +new, default config file at that location. + +## JSON Schema + +The configuration file also has [JSON Schema](https://json-schema.org/) support to make it easier to manage, if your +IDE/editor supports it. diff --git a/docs/content/configuration/config-file/layout.md b/docs/content/configuration/config-file/layout.md index 76bd6e33..c5f35465 100644 --- a/docs/content/configuration/config-file/layout.md +++ b/docs/content/configuration/config-file/layout.md @@ -54,4 +54,4 @@ Each component of the layout accepts a `ratio` value. If this is not set, it def Furthermore, you can have duplicate widgets. -For an example, look at the [default config](https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml), which contains the default layout. +For an example, look at the [default config](https://github.com/ClementTsang/bottom/blob/main/sample_configs/default_config.toml), which contains the default layout. diff --git a/docs/content/contribution/development/build_process.md b/docs/content/contribution/development/build_process.md index 3ce28aa4..ea35ae17 100644 --- a/docs/content/contribution/development/build_process.md +++ b/docs/content/contribution/development/build_process.md @@ -10,7 +10,7 @@ ## Overview -bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml), called by a wrapper workflow for [nightly](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml) and [stable](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml) releases. Builds take place via GitHub Actions. +bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml), called by a wrapper workflow for [nightly](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml) and [stable](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml) releases. Builds take place via GitHub Actions. The main things built are: @@ -18,7 +18,7 @@ The main things built are: - MSI installer for Windows - `.deb` package for Debian and its derivatives -This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml) file. +This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml) file. ## Binaries diff --git a/docs/content/contribution/development/deploy_process.md b/docs/content/contribution/development/deploy_process.md index b9664f79..ff660c68 100644 --- a/docs/content/contribution/development/deploy_process.md +++ b/docs/content/contribution/development/deploy_process.md @@ -12,8 +12,8 @@ bottom currently has two main deploy processes to worry about: -- [Nightly](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml): a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the [nightly release](https://github.com/ClementTsang/bottom/releases/tag/nightly). It can also be triggered manually as either a proper nightly release or a mock release. -- [Stable](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml): a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release. +- [Nightly](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml): a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the [nightly release](https://github.com/ClementTsang/bottom/releases/tag/nightly). It can also be triggered manually as either a proper nightly release or a mock release. +- [Stable](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml): a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release. Furthermore, this workflow does not handle the following deployments, which must be manually handled: diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md index 8922922a..ac09e865 100644 --- a/docs/content/contribution/documentation.md +++ b/docs/content/contribution/documentation.md @@ -10,10 +10,10 @@ There are a few areas where documentation changes are often needed: -- The [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) -- The help menu inside of the application (located [here](https://github.com/ClementTsang/bottom/blob/master/src/constants.rs)) +- The [`README.md`](https://github.com/ClementTsang/bottom/blob/main/README.md) +- The help menu inside of the application (located [here](https://github.com/ClementTsang/bottom/blob/main/src/constants.rs)) - The [extended documentation](https://clementtsang.github.io/bottom/nightly/) (here) -- The [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md) +- The [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md) ## How should I add/update documentation? @@ -23,20 +23,20 @@ There are a few areas where documentation changes are often needed: <h3><code>README.md</code> or <code>CHANGELOG.md</code></h3> - For changes to [`README.md`](https://github.com/ClementTsang/bottom/blob/master/README.md) and [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md), just follow the formatting provided and use any editor. + For changes to [`README.md`](https://github.com/ClementTsang/bottom/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md), just follow the formatting provided and use any editor. - Generally, changes to [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md) will be handled - by a maintainer, and changes should follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format, as - well as link to the relevant PR or issue. + Generally, changes to [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md) will be handled + by a maintainer, and the contents of the file should follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) + format, as well as link to the relevant PR or issues. <h3>Help menu</h3> - For changes to the help menu, try to refer to the existing code within [`src/constants.rs`](https://github.com/ClementTsang/bottom/blob/master/src/constants.rs) on how the help menu is generated. + For changes to the help menu, try to refer to the existing code within [`src/constants.rs`](https://github.com/ClementTsang/bottom/blob/main/src/constants.rs) on how the help menu is generated. <h3>Extended documentation</h3> - For changes to the extended documentation, you'll probably want at least Python 3.11 (older versions should be fine - though), [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), + For changes to the extended documentation, you'll probably want at least Python 3.11 (older and newer versions + should be fine), [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), `mdx_truly_sane_lists`, and optionally [Mike](https://github.com/jimporter/mike) installed. These can help with validating your changes locally. diff --git a/docs/content/contribution/issues-and-pull-requests.md b/docs/content/contribution/issues-and-pull-requests.md index 86e0d58f..7429595b 100644 --- a/docs/content/contribution/issues-and-pull-requests.md +++ b/docs/content/contribution/issues-and-pull-requests.md @@ -26,7 +26,7 @@ The expected workflow for a pull request is: 1. Fork the project. 2. Make your changes. 3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](./documentation.md) for tips on documentation. -4. Commit and create a pull request to merge into the `master` branch. **Please fill out the pull request template**. +4. Commit and create a pull request to merge into the `main` branch. **Please fill out the pull request template**. 5. Ask a maintainer to review your pull request. - Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first-time contributor, you may need to wait for a maintainer to let CI run. diff --git a/docs/content/contribution/packaging-and-distribution.md b/docs/content/contribution/packaging-and-distribution.md index 4a0941ed..a41384c3 100644 --- a/docs/content/contribution/packaging-and-distribution.md +++ b/docs/content/contribution/packaging-and-distribution.md @@ -11,10 +11,10 @@ completion files for zsh, bash, fish, and Powershell, which you may want to also process. You can also find a nightly build in the [releases page](https://github.com/ClementTsang/bottom/releases), built every -day at 00:00 UTC off of the master branch. +day at 00:00 UTC off of the `main` branch. In both cases, we use a combination of GitHub Actions and CirrusCI (mainly for FreeBSD and macOS M1) to create our -release binaries. [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml) +release binaries. [`build_releases.yml`](https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml) contains the GitHub Action workflow used to do both of these, if reference is needed. ## Building manually @@ -34,7 +34,7 @@ cargo build --release --locked ### Manpage and completion generation -bottom uses a [`b |