Skip to content

Commit 00e1c0a

Browse files
authored
Update README.md
1 parent 4703fb4 commit 00e1c0a

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# GitWave - Multi-Repository Bash Command Runner
22
[![Apache License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://github.com/introfog/GitWave/blob/master/LICENSE.md)
3+
[![Build and Package](https://github.com/introfog/GitWave/actions/workflows/maven.yml/badge.svg)](https://github.com/introfog/GitWave/actions/workflows/maven.yml)
34

45
## <img src="./src/main/resources/logo32.png" alt="GitWave Logo"> Overview
5-
Welcome to GitWave – the ultimate tool for developers who work with multiple repositories on Windows. GitWave is
6+
Welcome to GitWave – the ultimate tool for developers who work with multiple repositories. GitWave is
67
designed to streamline your workflow by allowing you to run any bash commands across several repositories simultaneously.
78
It’s a powerful companion for any developer looking to save time and effort when managing their Git projects.
89

@@ -12,18 +13,21 @@ Execute bash commands in multiple repositories with a single command, making it
1213
### 2. Command Management
1314
Save your most used or tricky commands with notes, so you never have to remember the syntax again.
1415
Specify `{parameters}` for the command, to quickly run different scenarios.
15-
### 3. Standalone Application
16+
### 3. Multi-OS Compatibility: Windows, macOS & Linux
17+
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.
19+
### 4. Standalone Application
1620
GitWave is a standalone application that doesn't leave any footprint on your PC. It respects your
1721
system's cleanliness by ensuring that no unnecessary files or configurations are left behind,
1822
providing a hassle-free and straightforward experience for users.
19-
### 4. Open Source
23+
### 5. Open Source
2024
GitWave is an open-source project, that encourages collaboration and community involvement.
2125
Explore, contribute, and customize the application according to your preferences.
2226

2327
## :checkered_flag: Getting Started
2428
To enjoy GitWave you don't need any JDK, because it already includes JDK.
25-
1. Download `GitWave.zip` from the [latest release](https://github.com/introfog/GitWave/releases).
26-
2. Unpack archive to your local machine and launch `GitWave.exe`.
29+
1. Download `GitWave_yourOS.zip` from the [latest release](https://github.com/introfog/GitWave/releases).
30+
2. Unpack archive to your local machine and launch `GitWave.exe` (for Windows) or `GitWave.sh` (on macOS and Linux).
2731
3. Begin executing bash commands across multiple repositories effortlessly.
2832
4. You can check my personal [GitWave config](https://gist.github.com/introfog/10a0a3f6c0b069c4132f8ac18b73dff5) with bash commands which i use on regular basis.
2933

@@ -36,19 +40,19 @@ To enjoy GitWave you don't need any JDK, because it already includes JDK.
3640
### Build Options
3741
- To run the application execute `mvn javafx:run`.
3842
- To create ready to use app, archived into .zip, run `mvn package`. GitWave will be in `target/GitWave.zip` archive.
39-
- `GitWave.exe`, which runs java image, is located in the `tools` folder and generated by a separate C++ project `tools/GitWaveExecutor`.
43+
- `GitWave.exe`, which is used on Windows and runs java image, is located in the `tools` folder and generated by a separate C++ project `tools/GitWaveExecutor`.
44+
- `GitWave.sh`, which is used on macOS and Linux and runs java image, is located in the `tools` folder.
4045

4146
## :gear: Under the hood
4247
- GitWave is built on openjdk 11 + openjfx 11 and wrapped into Java Runtime Image.
4348
- 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.
4449
- 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`.
45-
- The `temp` folder is used to save bash scripts to run, they are automatically removed after the command completes.
4650

4751
## :bulb: Ideas For Further Releases
4852
- Allow working with the app by using only the keyboard (with correct Tabs, Esc and so on work).
4953
- Exclude sub-directories from the command running.
5054
- Allow export and import config.
51-
- Release version for Linux and macOS.
55+
- Other issues with `enhancement` label.
5256

5357
## :page_with_curl: License
5458
GitWave is licensed under the [Apache license](LICENSE.md), providing you with the freedom to use, modify, and distribute the software.

0 commit comments

Comments
 (0)