diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 2 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 2 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/packaging.md | 2 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | README.md | 30 | ||||
| -rw-r--r-- | docs/content/contribution/documentation.md | 2 |
6 files changed, 21 insertions, 21 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 974da1ea..89b87a6e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,7 +6,7 @@ labels: "bug" assignees: "" --- -Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/support/#known-problems) to see if your problem is already reported/known. +Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/#known-problems) to see if your problem is already reported/known. Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 6899493e..9cd22817 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,4 +11,4 @@ assignees: "" Please describe what behaviour you are looking for, the motivation for it, and use cases for where this feature would be helpful. Try to be clear and concise - more details are usually helpful, but don't ramble on too much. -Also try to see if this feature already exists first [in the documentation](https://clementtsang.github.io/bottom/). +Also try to see if this feature already exists first [in the documentation](https://clementtsang.github.io/bottom/nightly/). diff --git a/.github/ISSUE_TEMPLATE/packaging.md b/.github/ISSUE_TEMPLATE/packaging.md index 3a13b560..7eb1179a 100644 --- a/.github/ISSUE_TEMPLATE/packaging.md +++ b/.github/ISSUE_TEMPLATE/packaging.md @@ -10,4 +10,4 @@ assignees: "" What is the issue? Please be clear and concise. -Note: if this issue is about supporting a new package manager/installation method, please do consider maintaining it yourself and sending in a PR, and I'll be glad accept it! See [the documentation](https://clementtsang.github.io/bottom/contribution/packaging-and-distribution/) for more information. +Note: if this issue is about supporting a new package manager/installation method, please do consider maintaining it yourself and sending in a PR, and I'll be glad accept it! See [the documentation](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/) for more information. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0336185b..4c679913 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,5 +26,5 @@ The expected workflow for a pull request is: ## Further reading -- For details on contributing to documentation, see [here](https://clementtsang.github.io/bottom/contribution/documentation/). -- For details on packaging and distribution, see [here](https://clementtsang.github.io/bottom/contribution/packaging-and-distribution/). +- For details on contributing to documentation, see [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/). +- For details on packaging and distribution, see [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/). @@ -21,26 +21,26 @@ As (yet another) process/system visualization and management application, bottom - Graphical visualization widgets for: - - [CPU usage](https://clementtsang.github.io/bottom/usage/widgets/cpu/) over time, at an average and per-core level - - [RAM and swap usage](https://clementtsang.github.io/bottom/usage/widgets/memory/) over time - - [Network I/O usage](https://clementtsang.github.io/bottom/usage/widgets/network/) over time + - [CPU usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/) over time, at an average and per-core level + - [RAM and swap usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/) over time + - [Network I/O usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/network/) over time with support for zooming in/out the current time interval displayed. - Widgets for displaying info about: - - [Disk capacity/usage](https://clementtsang.github.io/bottom/usage/widgets/disk/) - - [Temperature sensors](https://clementtsang.github.io/bottom/usage/widgets/temperature/) - - [Battery usage](https://clementtsang.github.io/bottom/usage/widgets/battery/) + - [Disk capacity/usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/) + - [Temperature sensors](https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/) + - [Battery usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/) -- [A process widget](https://clementtsang.github.io/bottom/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for: +- [A process widget](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for: - Kill signals - Tree mode - Cross-platform support for Linux, macOS, and Windows, with more planned in the future. -- [Customizable behaviour](https://clementtsang.github.io/bottom/configuration/command-line-flags/) that can be controlled with command-line flags or a config file, such as: +- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/) that can be controlled with command-line flags or a config file, such as: - Custom and pre-built colour themes - Changing the default behaviour of some widgets @@ -49,12 +49,12 @@ As (yet another) process/system visualization and management application, bottom - Some other nice stuff, like: - - [An htop-inspired basic mode](https://clementtsang.github.io/bottom/usage/basic-mode/) - - [Expansion, which focuses on just one widget](https://clementtsang.github.io/bottom/usage/general-usage/#expansion) + - [An htop-inspired basic mode](https://clementtsang.github.io/bottom/nightly/usage/basic-mode/) + - [Expansion, which focuses on just one widget](https://clementtsang.github.io/bottom/nightly/usage/general-usage/#expansion) - And more! -You can find more details in [the documentation](https://clementtsang.github.io/bottom/usage/general-usage/). +You can find more details in [the documentation](https://clementtsang.github.io/bottom/nightly/usage/general-usage/). ## Support @@ -67,7 +67,7 @@ bottom _officially_ supports the following operating systems and corresponding a These platforms are tested to work for the most part and issues on these platforms will be fixed if possible. Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust. -For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://clementtsang.github.io/bottom/support). +For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://clementtsang.github.io/bottom/nightly/support). ## Installation @@ -234,16 +234,16 @@ The release binaries are packaged with shell auto-completion files for bash, fis You can run bottom using `btm`. - For help on flags, use `btm -h` for a quick overview or `btm --help` for more details. -- For info on key and mouse bindings, refer to the [documentation](https://clementtsang.github.io/bottom/) or press `?` inside bottom. +- For info on key and mouse bindings, refer to the [documentation](https://clementtsang.github.io/bottom/nightly/) or press `?` inside bottom. -You can generally find more information on usage in the [documentation](https://clementtsang.github.io/bottom/). +You can generally find more information on usage in the [documentation](https://clementtsang.github.io/bottom/nightly/). ## Configuration bottom accepts a number of command-line arguments to change the behaviour of the application as desired. Additionally, bottom will automatically generate a configuration file on the first launch, which one can change as appropriate. -More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/configuration/config-file/default-config/). +More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/). ## Contribution diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md index b7e57d6f..75952b7f 100644 --- a/docs/content/contribution/documentation.md +++ b/docs/content/contribution/documentation.md @@ -9,7 +9,7 @@ There are a few areas where documentation changes are often needed: -- The [extended documentation](https://clementtsang.github.io/bottom/) (AKA here) +- The [extended documentation](https://clementtsang.github.io/bottom/nightly/) (AKA here) - 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 [`CHANGELOG.md`](https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md) |