docs: Add FAQ document (#339)

This commit is contained in:
Clement Tsang 2020-12-04 20:11:38 -05:00 committed by GitHub
parent e56367fcbb
commit 5531255135
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 7 deletions

View File

@ -33,7 +33,7 @@ jobs:
components: rustfmt
- run: cargo fmt --all -- --check
# Check clippy.
# Check clippy. This doesn't check ARM though.
clippy:
runs-on: ${{ matrix.os }}
strategy:
@ -45,12 +45,6 @@ jobs:
steps:
- uses: actions/checkout@v2
# - name: Cache Cargo
# uses: actions/cache@v1
# with:
# path: target
# key: clippy-${{ runner.os }}-${{ hashFiles('**/Cargo.toml') }}
- uses: actions-rs/toolchain@v1
with:
profile: minimal

12
FAQ.md Normal file
View File

@ -0,0 +1,12 @@
# FAQ
- [My graphs look kinda weird with some extra dots, how do I fix this?](#braille-support)
<h3 name="braille-support">
My graphs look kinda weird with some extra dots, how do I fix this?
</h3>
![example_image](https://user-images.githubusercontent.com/14301439/100946236-2db2f480-34c0-11eb-9f32-41202a8fe6e2.png)
You'll have to make sure you have proper braille font support. For example, for Arch, you may have to
install ttf-ubraille and/or properly set it up for your terminal.

View File

@ -55,6 +55,7 @@ A cross-platform graphical process/system monitor with a customizable interface
- [Disk and temperature filtering](#disk-and-temperature-filtering)
- [Battery](#battery)
- [Compatibility](#compatibility)
- [FAQ](#faq)
- [Contribution](#contribution)
- [Contributors](#contributors)
- [Thanks](#thanks)
@ -728,6 +729,10 @@ The current compatibility of widgets with operating systems from personal testin
| Windows | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ | ✓ (seems to have issues with dual batteries) |
| macOS | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
## FAQ
Please see the [FAQ](./FAQ.md) for answers to frequently asked questions.
## Contribution
Contribution is always welcome! Please take a look at [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to help.