tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
bottom/docs/content/support.md

43 lines
1.8 KiB
Markdown
Raw Normal View History

docs: migrate documentation over to mkdocs (#506) 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.
2021-06-21 07:40:58 +02:00
# Support
## Official support
bottom _officially_ supports the following operating systems and corresponding architectures:
- macOS (`x86_64`)
- Linux (`x86_64`, `i686`, `aarch64`)
- Windows (`x86_64`, `i686`)
These platforms are tested to work (with caveats, see below) 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 - if you are manually building
bottom from the repo/source, then please try that as well.
### Known problems
#### Windows
- The temperature widget seems to require elevated access in some cases to get data.
- The battery widget seems to have issues with dual battery systems, like some Thinkpads.
- If you run on WSL/WSL2, you may have issues with getting memory data.
- WSL and WSL2 (as far as I know) cannot correctly report temperature sensors.
- WSL2 will not match Windows' own Task Manager in terms of data.
#### macOS
docs: Fix some missing text in docs
2021-06-21 08:03:10 +02:00
- The process widget may require elevated access (ex: `sudo btm`) to gather all data in some cases. _Please note that you should be certain that you trust any software you grant root privileges._
docs: migrate documentation over to mkdocs (#506) 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.
2021-06-21 07:40:58 +02:00
## Unofficial support
Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will work. Furthermore,
while it will depend on the problem at the end of the day, _issues on unsupported platforms are likely to go unfixed_.
!!! note
bottom is tested to build on other ARM and PowerPC architectures through [CI](https://github.com/ClementTsang/bottom/blob/master/.github/workflows/ci.yml),
but since they are not officially tested to work on a sample platform, they are only unofficially supported.
### Known problems
- M1-based macOS devices may have issues with temperature sensors not returning anything.