Skip to content

Commit 07210de

Browse files
authored
Update README.md
1 parent 3e26c8f commit 07210de

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Save your most used or tricky commands with notes, so you never have to remember
1515
Specify `{parameters}` for the command, to quickly run different scenarios.
1616
### 3. Multi-OS Compatibility: Windows, macOS & Linux
1717
Application is fully compatible with Windows x86, macOS arm64 and Linux x86, ensuring a smooth experience across all major operating systems.
18-
Corresponding OS-specific artifacts are available for download in the GitHub Releases section.
18+
Corresponding OS-specific artifacts are available for download in the Releases section.
1919
### 4. Standalone Application
2020
GitWave is a standalone application that doesn't leave any footprint on your PC. It respects your
2121
system's cleanliness by ensuring that no unnecessary files or configurations are left behind,
@@ -28,14 +28,16 @@ Explore, contribute, and customize the application according to your preferences
2828
To enjoy GitWave you don't need any JDK, because it already includes JDK.
2929
1. Download `GitWave_yourOS.zip` from the [latest release](https://github.com/introfog/GitWave/releases).
3030
2. Unpack archive to your local machine and launch `GitWave.exe` (for Windows) or `GitWave.sh` (on macOS and Linux).
31-
3. Begin executing bash commands across multiple repositories effortlessly.
32-
4. You can check my personal [GitWave config](https://gist.github.com/introfog/10a0a3f6c0b069c4132f8ac18b73dff5) with bash commands which i use on regular basis.
31+
- Before running `GitWave.sh` on MacOs and Linux, make the script executable by running `chmod +x ./GitWave.sh`.
32+
- MacOs complains that Apple couldn't verify that `java` is free of malware, go to `Privacy & Security` and allow running `java`.
33+
4. Begin executing bash commands across multiple repositories effortlessly.
34+
5. You can check my personal [GitWave config](https://gist.github.com/introfog/10a0a3f6c0b069c4132f8ac18b73dff5) with bash commands which i use on regular basis.
3335

3436
<img src=samples/Sample_Saved_Commands.gif>
3537

3638
## :hammer: Build Locally
3739
### Software Requirements
38-
- JDK 11 or higher.
40+
- JDK 17 or higher.
3941
- Maven.
4042
### Build Options
4143
- To run the application execute `mvn javafx:run`.
@@ -44,7 +46,7 @@ To enjoy GitWave you don't need any JDK, because it already includes JDK.
4446
- `GitWave.sh`, which is used on macOS and Linux and runs java image, is located in the `tools` folder.
4547

4648
## :gear: Under the hood
47-
- GitWave is built on openjdk 11 + openjfx 11 and wrapped into Java Runtime Image.
49+
- GitWave is built on openjdk 17 + openjfx 17 and wrapped into Java Runtime Image.
4850
- All commands and settings are stored in `config/config.json` in JSON format. So it is possible to edit them manually in any text editor.
4951
- On opening the app makes a lenient request to GitHub API to check for the new available release, see `com.github.introfog.gitwave.model.UpdateChecker#isNewReleaseAvailable`.
5052

0 commit comments

Comments
 (0)