Add Windows build-and-release workflow with Inno Setup installer

.github/workflows/build-and-release.yaml

@@ -0,0 +1,143 @@
+name: Build for release
+
+on:
+  push:
+    branches: [master]
+    tags: [v*]
+  pull_request:
+
+jobs:
+  get-newest-supported-ghc:
+    name: Get the newest supported GHC
+    outputs:
+      matrix: ${{ steps.get-latest-version.outputs.matrix }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Extract the tested GHC versions
+        id: get-latest-version
+        uses: webdevred/get-tested@4671a0284723f30fa7f97989ff1f9513167180fe
+        with:
+          cabal-file: jbeam-edit.cabal
+          windows-version: latest
+          version: get-tested-for-jbeam-edit
+          newest: true
+  build-for-release:
+    runs-on: windows-latest
+    needs: get-newest-supported-ghc
+    name: Build for release for ${{ matrix.ghc }}
+    strategy:
+      matrix: ${{ fromJSON(needs.get-newest-supported-ghc.outputs.matrix) }}
+    steps:
+      - uses: actions/checkout@v5.0.0
+      - name: Set up GHC latest and Cabal
+        id: setup-ghc
+        uses: haskell-actions/setup@v2.8.1
+        with:
+          ghc-version: ${{ matrix.ghc }}
+          cabal-version: latest
+          cabal-update: true
+      - name: Enable optimization for building on tags
+        if: startsWith(github.ref, 'refs/tags/')
+        run: cabal configure --project-file cabal.project.release -O2
+      - name: Enable tests for non-tags
+        if: "!startsWith(github.ref, 'refs/tags/')"
+        run: cabal configure --project-file cabal.project.release --enable-tests
+      - name: Cache GHC, Cabal store, and build artifacts
+        uses: actions/cache@v4.2.4
+        if: "!startsWith(github.ref, 'refs/tags/')"
+        with:
+          path: |
+            dist-newstyle
+            ${{ steps.setup-ghc.outputs.cabal-store }}
+          key: >-
+            ${{ runner.os }}-cabal-${{
+              matrix.ghc
+            }}-${{
+              hashFiles('**/package.yaml')
+            }}
+          restore-keys: |
+            ${{ runner.os }}-cabal-${{ matrix.ghc }}-
+      - name: Build executables
+        run: cabal build exe:jbeam-edit --project-file cabal.project.release
+      - name: Run tests (GHC ${{ matrix.ghc }})
+        if: "!startsWith(github.ref, 'refs/tags/')"
+        run: cabal test --project-file cabal.project.release
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: jbeam-edit-${{ matrix.ghc }}
+          path: dist-newstyle
+  release:
+    runs-on: windows-latest
+    needs: [build-for-release, get-newest-supported-ghc]
+    if: startsWith(github.ref, 'refs/tags/')
+    name: Release for Windows
+    strategy:
+      matrix: ${{ fromJSON(needs.get-newest-supported-ghc.outputs.matrix) }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download build artifact
+        uses: actions/download-artifact@v5.0.0
+        with:
+          name: jbeam-edit-${{ matrix.ghc }}
+          path: dist-newstyle
+      - name: Prepare release folder
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $releaseDir = "$env:GITHUB_WORKSPACE\dist\release"
+          if (Test-Path $releaseDir) { Remove-Item $releaseDir -Recurse -Force -ErrorAction SilentlyContinue }
+          New-Item -ItemType Directory -Path $releaseDir | Out-Null
+
+          $exePath = Get-ChildItem -Path "$env:GITHUB_WORKSPACE\dist-newstyle\build" -Recurse -Filter "jbeam-edit.exe" -ErrorAction SilentlyContinue | Select-Object -First 1
+          if (-not $exePath) {
+            Write-Error "jbeam-edit.exe not found in dist-newstyle build tree. Make sure build-for-release succeeded."
+          }
+          Copy-Item $exePath.FullName $releaseDir
+
+          $jbflDest = Join-Path $releaseDir "examples\jbfl"
+          New-Item -ItemType Directory -Path $jbflDest -Force | Out-Null
+          Copy-Item -Path "examples\jbfl\*" -Destination $jbflDest -Recurse -Force
+
+          Copy-Item README.md $releaseDir -Force
+          Copy-Item JBFL_DOCS.md $releaseDir -Force
+          Copy-Item LICENSE $releaseDir -Force
+      - name: Build Inno Setup Installer
+        uses: Minionguyjpro/Inno-Setup-Action@v1.2.2
+        with:
+          path: installer/setup.iss
+          options: /O+
+      - name: Locate and move setup.exe into release folder
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $found = Get-ChildItem -Path "$env:GITHUB_WORKSPACE" -Recurse -Filter "setup.exe" -ErrorAction SilentlyContinue |
+                   Where-Object { $_.FullName -notmatch "\\\.git\\" } |
+                   Select-Object -First 1
+          if (-not $found) {
+            Write-Error "setup.exe not found after Inno Setup run. Check installer/output location."
+          }
+          $releaseSetupPath = Join-Path "$env:GITHUB_WORKSPACE\dist\release" "setup.exe"
+          Copy-Item $found.FullName $releaseSetupPath -Force
+          Write-Host "Copied setup.exe to $releaseSetupPath"
+      - name: Create zip containing setup.exe and docs
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $zipFile = "$env:GITHUB_WORKSPACE\dist\jbeam-edit-${env:GITHUB_REF_NAME}.zip"
+          $zipDir = "$env:GITHUB_WORKSPACE\dist\zip_temp"
+          if (Test-Path $zipDir) { Remove-Item $zipDir -Recurse -Force -ErrorAction SilentlyContinue }
+          New-Item -ItemType Directory -Path $zipDir | Out-Null
+
+          Copy-Item "$env:GITHUB_WORKSPACE\dist\release\setup.exe" $zipDir -Force
+          Copy-Item "$env:GITHUB_WORKSPACE\dist\release\README.md" $zipDir -Force
+          Copy-Item "$env:GITHUB_WORKSPACE\dist\release\JBFL_DOCS.md" $zipDir -Force
+          Copy-Item "$env:GITHUB_WORKSPACE\dist\release\LICENSE" $zipDir -Force
+          Add-Type -AssemblyName System.IO.Compression.FileSystem
+          [System.IO.Compression.ZipFile]::CreateFromDirectory($zipDir, $zipFile)
+          Write-Host "Created zip: $zipFile"
+      - name: Create GitHub Release and upload zip
+        uses: softprops/action-gh-release@v2.3.2
+        with:
+          tag_name: ${{ github.ref_name }}
+          draft: true
+          generate_release_notes: true
+          files: |-
+            dist/jbeam-edit-${{ github.ref_name }}.zip

.github/workflows/build-and-test.yaml

@@ -69,7 +69,7 @@ jobs:
       - name: Run tests
         run: stack test --fast
   generate-matrix:
-    name: "Generate matrix from cabal"
+    name: Generate matrix from cabal
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     runs-on: ubuntu-latest
@@ -79,7 +79,7 @@ jobs:
         uses: kleidukos/get-tested@v0.1.7.1
         with:
           cabal-file: jbeam-edit.cabal
-          ubuntu-version: "latest"
+          ubuntu-version: latest
           version: 0.1.7.1
   build-with-cabal:
     name: Build and test with Cabal (GHC ${{ matrix.ghc }})

.gitignore

@@ -3,6 +3,7 @@ cabal.project.local~
 dist-newstyle/
 TAGS
 .stack-work/
+.ghc.environment.*
 **/*~
 **/#*#
 **/.#*

README.md

@@ -28,7 +28,7 @@ A fast, robust command-line parser, formatter, and editor for JBeam files, the J
   Uniform indentation, spacing, and layout for improved readability.
 
 - **Automatic Node Management:**
-  Renames nodes sequentially (e.g., `["bf1", ...]` → `["bf0", "bf1", "bf2"]`) and updates all references automatically.
+  Renames nodes sequentially (e.g., `["bf1", ...]` → `["bf0", "bf1", "bf2"]`) and updates all references automatically. Feature currently unstable, enabled by build flag `transformation`.
 
 - **Configurable Formatting with JBFL:**
   Customize formatting rules using JBFL, a mini-language to specify padding, decimals, indentation, and more with wildcard targeting.
@@ -64,27 +64,67 @@ Override per project by placing `.jbeam_edit.jbfl` in your project root.
 
 ## Usage
 
-Build and run:
+### 1. Download the latest release
+Go to the [Releases page](https://github.com/webdevred/jbeam_edit/releases) and download the most recent **`.zip`** file.
 
-```bash
-git clone https://github.com/webdevred/jbeam-tool.git
-cd jbeam-tool
-stack build
-stack exec jbeam-tool -- [options] <input-file>
+### 2. Unzip the file
+Extract the contents of the downloaded `.zip` archive to a folder of your choice.
+
+### 3. Run the setup as Administrator
+
+Inside the extracted folder, right-click on **setup.exe** and choose **Run as administrator**.
+
+## 4. Allow Windows protection if needed
+If Windows shows a warning such as:
+
+> *Windows protected your PC*
+
+Click **More info** → **Run anyway**.
+
+### 5. Path refresh
+The installer adds `jbeam-edit` to your **PATH**, but:
+- You must **open a new Command Prompt or PowerShell window** after installation.  
+- In some cases, you may need to **log out or restart Windows** for the PATH change to take effect.  
+- If it still doesn’t work, you can run it directly using the full path, e.g.:
+
+```powershell
+"C:\Program Files (x86)\jbeam_edit\jbeam-edit.exe" your-file.jbeam
 ```
 
-Typical workflow:
+### 6. Open Command Prompt or PowerShell
+Press **`Win + R`**, type `cmd` or `powershell`, and hit **Enter**.
 
-- Parses and formats the file.
-- Sorts and renames nodes, updating references.
-- Writes output back with a `.bak` backup by default.
+### 7. Run jbeam-edit on a file
+Navigate to your project folder in CMD/PowerShell and run:
 
-In-place editing (no backup):
+```powershell
+jbeam-edit your-file.jbeam
+```
 
-```bash
+Replace `your-file.jbeam` with the path to your JBeam file.
+
+#### Typical workflow:
+- Parses and formats the file.  
+- Sorts and renames nodes, updating references.  
+- Writes the output back with a `.bak` backup (default).  
+
+#### In-place editing (no backup):
+```powershell
 jbeam-edit -i example.jbeam
 ```
 
+### From source (Linux or development)
+
+Clone and build with Cabal:
+
+```bash
+git clone https://github.com/webdevred/jbeam_edit.git
+cd jbeam_edit
+cabal update
+cabal install
+jbeam-edit your-file.jbeam
+```
+
 ## Examples
 
 For sample `.jbeam` files and JBFL rule files, see the [Examples Directory README](examples/README.org).
@@ -116,8 +156,10 @@ For an in-depth walkthrough of the implementation and design decisions, see [EXP
 
 ## Prerequisites
 
-- GHC (The Glasgow Haskell Compiler)
-- Stack build tool
+- **Windows users (BeamNG players):** none, just download the installer from [Releases](https://github.com/webdevred/jbeam_edit/releases/latest).
+- **Developers / Linux users:**
+  - [GHC](https://www.haskell.org/ghc/) (Glasgow Haskell Compiler)
+  - [Cabal](https://www.haskell.org/cabal/) build tool (comes with GHCup)
 
 ## Contributing & License
 

cabal.project

@@ -0,0 +1,5 @@
+packages: .
+tests: True
+
+package jbeam-edit
+  flags: +dump-ast +transformation -windows-example-paths

cabal.project.ci

@@ -1,9 +1,5 @@
-packages: .
-tests: True
+import: cabal.project
 test-show-details: direct
 
 program-options
   ghc-options: -Werror
-
-package jbeam-edit
-  flags: +dump-ast +transformation

cabal.project.dev

@@ -1,7 +1,14 @@
-packages: .
+import: cabal.project
+write-ghc-environment-files: always
 
 package *
-  ghc-options: -haddock
+  optimization: 0
+  debug-info: True
+  tests: True
+  documentation: True
+  library-for-ghci: True
 
 package jbeam-edit
-  flags: +dump-ast +transformation
+  haddock-executables: True
+  haddock-internal: True
+  haddock-tests: True

cabal.project.release

@@ -0,0 +1,12 @@
+import: cabal.project
+tests: False
+executable-static: True
+
+package *
+  ghc-options:
+    -threaded
+    -rtsopts
+    -with-rtsopts=-N
+
+package jbeam-edit
+  flags: -dump-ast -transformation +windows-example-paths

installer/setup.iss

@@ -0,0 +1,18 @@
+; -- Basic Inno Setup Script for jbeam-edit --
+
+[Setup]
+AppName=jbeam-edit
+AppVersion=0.0.1.0
+DefaultDirName={pf}\jbeam-edit
+DefaultGroupName=jbeam-edit
+OutputBaseFilename=setup
+Compression=lzma
+SolidCompression=yes
+
+[Files]
+Source: "..\dist\release\jbeam-edit.exe"; DestDir: "{app}"; Flags: ignoreversion
+Source: "..\dist\release\examples\jbfl\*"; DestDir: "{app}\examples\jbfl"; Flags: recursesubdirs createallsubdirs ignoreversion
+
+[Registry]
+  Root: HKCU; Subkey: "Environment"; ValueType: string; ValueName: "Path"; \
+    ValueData: "{olddata};{app}"; Flags: preservestringtype uninsdeletevalue

jbeam-edit.cabal

@@ -5,7 +5,7 @@ cabal-version:      2.2
 -- see: https://github.com/sol/hpack
 
 name:               jbeam-edit
-version:            0.1.0.0
+version:            0.0.1.0
 license:            BSD-3-Clause
 license-file:       LICENSE
 copyright:          2025 webdevred
@@ -40,6 +40,13 @@ flag transformation
     default:     False
     manual:      True
 
+flag windows-example-paths
+    description:
+        Use executable-relative example paths (for Windows release builds)
+
+    default:     False
+    manual:      True
+
 library
     exposed-modules:
         CommandLineOptions
@@ -82,6 +89,9 @@ library
         exposed-modules: Transformation
         hs-source-dirs:  src-extra/transformation
 
+    if (os(windows) && flag(windows-example-paths))
+        cpp-options: -DWINDOWS_EXAMPLE_PATHS
+
 executable jbeam-edit
     main-is:            Main.hs
     hs-source-dirs:     app