Minor fixes (#6)

* ci: add winfowsgui build flag

* ci: use Windows for PR build

* ci: add release action

* ci: set job name

* fix: set correct release action

* fix: update action tag

* fix: uppdate runner

* ci: update release action

* doc: update build command

* chore: enable PR action

* doc: update readme

* ci: set job name

* ci: update release action

* chore: enable PR action

* doc: update readme

* ci: update runner instance

* ci: add package install

* ci: use ubuntu runner

* doc: update readme

Author: clemthi

.github/workflows/pull_request.yml

@@ -1,33 +1,39 @@
 name: Pull Request
 run-name: Pull Request on ${{ github.ref_name }} by @${{ github.actor }}
 
+
 on: 
   - pull_request
   - workflow_dispatch
 
 
 jobs:
 
-  validate:
-    runs-on: 
-      - windows-latest
+  validate-and-build:
+    runs-on:
+      - ubuntu-latest
     timeout-minutes: 15
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
+      - name: Install libs
+        run: sudo apt install -y gcc libgtk-3-dev libayatana-appindicator3-dev
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
       - name: Vet
         run: go vet ./...
       - name: Build
-        run: go build -v -o runsyncapps -ldflags="-H windowsgui" ./cmd
+        run: go build -v -o runsyncapps ./cmd
 
   vulnerability-check:
     runs-on:
-      - macos-latest
+      - ubuntu-latest
+    timeout-minutes: 15
     steps:
+      - name: Install libs
+        run: sudo apt install -y gcc libgtk-3-dev libayatana-appindicator3-dev
       - name: govulncheck
         uses: golang/govulncheck-action@v1
         with:

.github/workflows/release.yml

@@ -1,6 +1,7 @@
 name: Release
 run-name: Release on ${{ github.ref_name }} by @${{ github.actor }}
 
+
 on:
   pull_request:
     types:

README.md

@@ -1,25 +1,30 @@
-# RunSyncedApp
+# RunSyncApps
 
-This small application allows to start multiple applications at once and if one of them is closed, the others are killed. A system tray icon allows the using to exit the application without killing the child processes.
+This small application allows to start multiple programs at once and if one of them is closed, the others are killed. Tested on Windows 11 and MacOS 14.5
 
-## Bulding
+- [1. Building](#1-building)
+- [2. Usage](#2-usage)
+- [3. JSON configuration](#3-json-configuration)
+- [4. SystemTray icon](#4-systemtray-icon)
+
+## 1. Building
 
 ```shell
 go build -o="runsyncapps.exe" ./cmd/
 ```
 
-You can add the buyild flag `-ldflags="-H windowsgui"` to avoid the console to open when starting the app.
+On Windows, You can add the build flag `-ldflags="-H windowsgui"` to avoid the console to open when starting the app.
 
-## Usage
+## 2. Usage
 
 ```shell
-runsyncedapp.exe --config=myconfig.json --log
+runsyncapps.exe --config=myconfig.json --log
 ```
 
-- `config` : path of the config file
-- `log` : log events in a `trace_<timestamp>.log` file
+- `config` : path of the config file (`config.json` by default)
+- `log` : log events in a `trace_<timestamp>.log` file (disabled by default)
 
-## JSON configuration
+## 3. JSON configuration
 
 The configuration file looks like this:
 
@@ -49,9 +54,17 @@ The configuration file looks like this:
 
 The parameters are the following:
 
-- `waitCheck`: time in second to wait after the applications starts and the verifications
-- `waitExit`: time in second to wait before the applications closures
-- `applications`: array of application to execute:
+- `waitCheck`: timer (in seconds) after the processes are being monitored
+- `waitExit`: timer (in seconds) before the processes are being killed
+- `applications`: array of application to start:
   - `path`: full path of the application
-  - `useExistingInstance`: don't start a new instance if it's already running
+  - `useExistingInstance`: don't start a new instance if there is one already running
   - `killOnExit`: kill the application if it's running after another app has been killed
+
+## 4. SystemTray icon
+
+A system tray icon allows the using to exit the application without killing the child processes.
+
+This works by default on Windows.
+
+On MacOS you will need to bundle the application (see [getlantern/systray lib info](https://github.com/getlantern/systray/blob/master/README.md) and [official Apple documentation](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/BundleTypes/BundleTypes.html#//apple_ref/doc/uid/10000123i-CH101-SW1)).

internal/gui.go

@@ -6,8 +6,8 @@ import (
 
 func OnReadyUI() {
 	systray.SetTemplateIcon(SysTrayIcon, SysTrayIcon)
-	systray.SetTitle("RunSyncApp")
-	systray.SetTooltip("RunSyncApp")
+	systray.SetTitle("RunSyncApps")
+	systray.SetTooltip("RunSyncApps")
 
 	// Exit menu
 	mQuitOrig := systray.AddMenuItem("Quit", "Quit")