bottom/docs/content/index.md
Clement Tsang e1be318177
docs: update usage and config, add blurb in home (#876)
* docs: update usage and config, add blurb in home

* add doc pages to pr template
2022-11-07 23:36:27 -05:00

1.6 KiB

title
Home

bottom

A customizable cross-platform graphical process/system monitor for the terminal, supporting Linux, macOS, and Windows. Inspired by other tools like gtop, gotop, and htop.


This site serves as extended documentation for bottom alongside the README.md.

!!! Warning

Some areas of this site are still in progress and may be missing details.  Feel free to suggest/contribute changes!

Installation

!!! Tip

It is a good idea to first check out the [Support](./support/official) page to see if your system is officially supported!

!!! Tip

If you're facing some issues during/after installation, check out the [Troubleshooting](./troubleshooting) page for some common problems and solutions.

To install bottom, refer to the installation section of the README.md, which contains a list of all the installation methods.

Usage and configuration

You can refer to the usage pages on how to use bottom (e.g. keybinds, some features, a general overview of what each widget does).

To configure bottom, refer to the configuration pages (e.g. how it behaves, how it looks).

Contribution

New contributors are always welcome! See the contribution section for how to contribute to bottom, whether it be filing issues, writing documentation, creating pull requests, etc.