summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2020-12-04 20:11:38 -0500
committerGitHub <noreply@github.com>2020-12-04 20:11:38 -0500
commit55312551357f2e1bb79d1abe5ef6425e5d593ab5 (patch)
tree72e1301161aeae07a03ed759c8e4cbc7e05f6005
parente56367fcbb933850f82140962542fb3f31627517 (diff)
docs: Add FAQ document (#339)
-rw-r--r--.github/workflows/ci.yml8
-rw-r--r--FAQ.md12
-rw-r--r--README.md5
3 files changed, 18 insertions, 7 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 1d8f6d41..866ae78f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -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
diff --git a/FAQ.md b/FAQ.md
new file mode 100644
index 00000000..651a49b7
--- /dev/null
+++ b/FAQ.md
@@ -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.
diff --git a/README.md b/README.md
index 2b8ffe00..dc5902e9 100644
--- a/README.md
+++ b/README.md
@@ -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.