Skip to content

Commit 69dec00

Browse files
authored
simplify readme and add linux installation
1 parent 56bb0eb commit 69dec00

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,13 @@ https://github.com/johnwangwyx/cmdCompass/assets/78456315/a0074ff6-7416-4127-87e
66

77

88
# Table of Contents
9-
1. [Features](#features)
10-
2. [Screenshots](#screenshots)
11-
3. [User Installation-Mac](#user-installation---mac)
12-
4. [User Installation-Windows](#user-installation---windows)
9+
1. [Screenshots](#screenshots)
10+
2. [User Installation-Mac](#user-installation---mac)
11+
3. [User Installation-Windows](#user-installation---windows)
12+
4. [User Installation-Linux](#user-installation---linux)
1313
5. [User Guide](#user-guide)
1414
6. [Contributing](#contributing)
1515

16-
## Features
17-
18-
* **Collections, Tags, Comments:** Group related commands into collections for easy access, categorize commands using tags with customizable colors, and add notes and descriptions to commands for better understanding.
19-
* **Command Templates:** Define commands with {{variables}} for dynamic replacement.
20-
* **Man (Manual) Page Integration:** View man pages directly within the app. Support automatic Highlighting for your command options.
21-
* **Dark/Light Mode:** Choose your preferred theme.
22-
* **Cross-Platform:** Works on Windows, and macOS. (Linux support will be added by ~May 26th~ June 2nd)
23-
2416
## Screenshots
2517
![image](https://github.com/johnwangwyx/cmdCompass/assets/78456315/e6010159-84a5-4fbf-a9c8-d614be41ce43)
2618
![image](https://github.com/johnwangwyx/cmdCompass/assets/78456315/c179fb52-c970-483a-88c0-944cba6ccff8)
@@ -39,7 +31,7 @@ Please install groff by:
3931
`brew install groff`
4032

4133
### Step 2:
42-
* Download the dmg app installer from [release](https://github.com/johnwangwyx/cmdCompass/releases/tag/v0.9.0). Open the installer and drag the CmdCompass app to your Application folder.
34+
* Download the dmg app installer from [release](https://github.com/johnwangwyx/cmdCompass/releases/tag/v1.0.0). Open the installer and drag the CmdCompass app to your Application folder.
4335

4436
<img width="300" alt="Screenshot 2024-05-23 at 4 38 37 PM" src="https://github.com/johnwangwyx/cmdCompass/assets/78456315/b709618a-2c40-4c48-887b-b628f3eb4dff">
4537

@@ -50,7 +42,7 @@ Please install groff by:
5042

5143

5244
## User Installation - Windows
53-
* Download the zip or the 7z archive from [release](https://github.com/johnwangwyx/cmdCompass/releases/tag/v0.9.0) and decompress it. You are now ready to use the App (cmdCompass.exe)!
45+
* Download the zip or the 7z archive from [release](https://github.com/johnwangwyx/cmdCompass/releases/tag/v1.0.0) and decompress it. You are now ready to use the App (cmdCompass.exe)!
5446

5547
Note: When you open the app for the first time, the Windows Smart Screen will open, Windows will block the app because it is an "unreconized app". You have to click on `More Info` and then a button will show up for you to open the app. (The App remain unreconized unless I pay $$$ to get a [certificate](https://www.reddit.com/r/electronjs/comments/17sizjf/a_guide_to_code_signing_certificates_for_the/) to sign my app)
5648

@@ -59,6 +51,10 @@ Note: When you open the app for the first time, the Windows Smart Screen will op
5951

6052
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.
6153

54+
## User Installation - Linux
55+
* Install `groff` with your package manager.
56+
* 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.
57+
6258
## User Guide
6359
### GUI breakdown
6460
Below is a breakdown of the different components and their use cases:

0 commit comments

Comments
 (0)