Updates and readme

Author: keynmol

.gitignore

@@ -21,3 +21,4 @@ docs/mdoc-invocation.txt
 local-bindgen
 worktree-main
 out
+.mcp.json

.vscode/launch.json

@@ -7,11 +7,11 @@
             "name": "Debug",
             "program": "${workspaceRoot}/out/debug/app",
             "cwd": "${workspaceRoot}",
-            "preLaunchTask": "buildBinary",
+            "preLaunchTask": "buildBinaryDebug",
             "args": [
                 "5000",
                 "1000"
             ]
         }
     ]
-}
+}

.vscode/tasks.json

@@ -1,13 +1,29 @@
 {
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "label": "buildBinary",
-            "command": "sbtn",
-            "args": [
-                "buildBinary",
-            ],
-            "type": "shell"
-        }
-    ]
-}
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build debug binary in ./out/debug",
+      "command": "sbtn",
+      "args": ["buildBinaryDebug"],
+      "type": "shell",
+    },
+    {
+      "label": "Build platform (name includes platform information) debug binary in ./out/debug",
+      "command": "sbtn",
+      "args": ["buildBinaryPlatformDebug"],
+      "type": "shell",
+    },
+    {
+      "label": "Build release binary in ./out/release",
+      "command": "sbtn",
+      "args": ["buildBinaryRelease"],
+      "type": "shell",
+    },
+    {
+      "label": "Build release platform (name includes platform information) binary in ./out/release",
+      "command": "sbtn",
+      "args": ["buildBinaryPlatformRelease"],
+      "type": "shell",
+    },
+  ],
+}

.zed/debug.json

@@ -7,11 +7,11 @@
     "label": "Build & Debug",
     "build": {
       "command": "sbtn",
-      "args": ["buildBinary"]
+      "args": ["buildBinaryDebug"],
     },
-    "program": "$ZED_WORKTREE_ROOT/out/debug/app",
+    "program": "./out/debug/app",
     "args": ["100", "50"],
     "request": "launch",
-    "adapter": "CodeLLDB" // GDB is available on non arm macs as well as linux
-  }
+    "adapter": "CodeLLDB", // GDB is available on non arm macs as well as linux
+  },
 ]

README.md

@@ -7,6 +7,17 @@ MacOS (arm64, amd64).
 Binaries are given descriptive platform-specific names, and upon creating a Github release 
 for a tag starting with `v`, binaries for all platforms are uploaded to release artifacts.
 
+SBT Commands to build the binary:
+  - `buildBinaryDebug` – produces `./out/debug/app`
+  - `buildBinaryRelease` – produces `./out/release/app`
+  - `buildBinaryPlatformDebug` - produces `./out/debug/app-...` with platform specific information encoded in the name (e.g. `./out/debug/app-aarch64-apple-darwin`)
+  - `buildBinaryPlatformRelease` - produces `./out/release/app-...` with platform specific information encoded in the name (e.g. `./out/release/app-aarch64-apple-darwin`)
+
+Github workflows:
+- Main branch merges and PRs: CI ([ci.yml](./.github/workflows/ci.yml)) – just makes sure that `buildBinaryDebug` succeeds on all platforms
+- Tags: release ([release.yml](./.github/workflows/release.yml)) – builds platform specific binary using `buildBinaryPlatformRelease` and uploads all
+  binaries as Github release assets
+
 The project itself
 
 - Uses latest Scala 3
@@ -24,7 +35,7 @@ Naming conventions loosely follow Coursier's practices.
 
 This template includes very basic setup for debugging with VS Code and [CodeLLDB extension](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb).
 
-You should have a `Debug` configuration available, which will automatically build a binary by invoking `sbtn buildBinary` command - 
+You should have a `Debug` configuration available, which will automatically build a binary by invoking `sbtn buildBinaryDebug` command - 
 so make sure you have sbtn installed (run `sbt installSbtn`).
 
 Please note that debugging information in Scala Native is very experimental, so don't expect a rich debugging experience you can 

build.sbt

@@ -1,13 +1,5 @@
 import com.indoorvivants.detective.Platform
 
-lazy val common = Seq(
-  scalaVersion := "3.8.3",
-  nativeConfig ~= { c =>
-    import scala.scalanative.build.*
-    c.withSourceLevelDebuggingConfig(SourceLevelDebuggingConfig.enabled)
-  }
-)
-
 lazy val root = project.in(file(".")).aggregate(lib, bin)
 
 lazy val lib =
@@ -22,6 +14,14 @@ lazy val bin = project
   .dependsOn(lib)
   .settings(common)
   .settings(
-    buildBinaryConfig ~= {_.withName("app")}
+    buildBinaryConfig ~= { _.withName("app") }
   )
 
+lazy val common = Seq(
+  scalaVersion := "3.8.3",
+  nativeConfig ~= { c =>
+    import scala.scalanative.build.*
+    c.withSourceLevelDebuggingConfig(SourceLevelDebuggingConfig.enabled)
+      .withIncrementalCompilation(true)
+  }
+)

mod/bin/src/main/scala/Main.scala

@@ -3,5 +3,5 @@ package sn_test.bin
 import sn_test.lib.Lib
 
 @main def hello(x: Int, y: Int) =
-  val z = x + y
+  val z = x + y + 2
   println(Lib.addition(x, y))