mirror of
https://github.com/ClementTsang/bottom.git
synced 2026-05-03 13:30:44 +00:00
Clement Tsang
06071d5abf
A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
30 lines
923 B
Markdown
30 lines
923 B
Markdown
## Description
|
|
|
|
_A description of the change and what it does. If relevant (such as any change that modifies the UI), **please provide screenshots** of the change:_
|
|
|
|
## Issue
|
|
|
|
_If applicable, what issue does this address?_
|
|
|
|
Closes: #
|
|
|
|
## Testing
|
|
|
|
_If relevant, please state how this was tested. All changes **must** be tested to work:_
|
|
|
|
_Furthermore, mark which platforms this change was tested on. All platforms directly affected by the change **must** be tested_
|
|
|
|
- [ ] _Windows_
|
|
- [ ] _macOS_
|
|
- [ ] _Linux_
|
|
|
|
## Checklist
|
|
|
|
_If relevant, ensure the following have been met:_
|
|
|
|
- [ ] _Areas your change affects have been linted using rustfmt (`cargo fmt`)_
|
|
- [ ] _The change has been tested and doesn't appear to cause any unintended breakage_
|
|
- [ ] _Documentation has been added/updated if needed (`README.md`, help menu, etc.)_
|
|
- [ ] _The pull request passes the provided CI pipeline_
|
|
- [ ] _There are no merge conflicts_
|