Skip to content

Commit 8869f1f

Browse files
authored
Update linux distro compatibility documentation
1 parent 69dec00 commit 8869f1f

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ https://github.com/johnwangwyx/cmdCompass/assets/78456315/a0074ff6-7416-4127-87e
99
1. [Screenshots](#screenshots)
1010
2. [User Installation-Mac](#user-installation---mac)
1111
3. [User Installation-Windows](#user-installation---windows)
12-
4. [User Installation-Linux](#user-installation---linux)
12+
4. [User Installation-Linux & Distro Compatibility](#user-installation---linux)
1313
5. [User Guide](#user-guide)
1414
6. [Contributing](#contributing)
1515

@@ -49,12 +49,18 @@ Note: When you open the app for the first time, the Windows Smart Screen will op
4949
<img src="https://github.com/johnwangwyx/cmdCompass/assets/78456315/db4f526c-3008-4c9f-b020-d98c715b964c" width="400">
5050
<img src="https://github.com/johnwangwyx/cmdCompass/assets/78456315/020caeda-0dce-4975-b986-5d04c7eab8d8" width="400">
5151

52-
In case you are wondering, for Windows, you don't need to install groff like Mac users. Groff is not available natively on Windows anyway but thanks to the project [EZWinPorts](https://www.gnu.org/software/emacs/manual/html_node/efaq-w32/EZWinPorts.html), I have added the groff binary built for Windows to the Windows build.
52+
In case you are wondering, for Windows, you don't need to install `groff` like Mac users. Groff is not available natively on Windows anyway but thanks to the project [EZWinPorts](https://www.gnu.org/software/emacs/manual/html_node/efaq-w32/EZWinPorts.html), I have added the groff binary built for Windows to the Windows build.
5353

5454
## User Installation - Linux
5555
* Install `groff` with your package manager.
56+
**Note on Debian or Ubuntu, even with `groff` already installed, you may likely need to run `sudo apt install groff` again as the pre-installed version is unable to convert to HTML documents, resulting in empty man HTML pages being displayed**
5657
* Download and decompress the app from [release](https://github.com/johnwangwyx/cmdCompass/releases/tag/v1.0.0). You can just right-click and run the `cmdCompass` executable with `GNOME` or run with `./cmdCompass` in terminal.
5758

59+
Below distros are tested:
60+
- [x] Ubuntu 24.04 with GNOME
61+
- [x] Debian 12.5.0 with GNOME
62+
- [x] CentOS-Stream-9 with GNOME
63+
5864
## User Guide
5965
### GUI breakdown
6066
Below is a breakdown of the different components and their use cases:

0 commit comments

Comments
 (0)