root clean up, scripts and benchmarks , expand .gitignore

Author: virtexalejandro

.gitignore

@@ -1,8 +1,19 @@
 # Build output
 build/
+build-bench/
 dist/
 out/
 
+# Local benchmark scratch output (the canonical run is tracked under docs/benchmarks/)
+/bench_*.txt
+/bench_*.json
+
+# Release artefacts produced by scripts/release_sdk.* (shipped via GitHub Releases, not git)
+/vtx-sdk-*.zip
+/vtx-sdk-*.zip.sha256
+/vtx-sdk-*.tar.gz
+/vtx-sdk-*.tar.gz.sha256
+
 # Local tool state (Claude Code, etc.)
 .claude/
 

CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to the VTX SDK will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- **scripts**: `scripts/release_sdk.sh` -- Linux/macOS counterpart to `scripts/release_sdk.bat`.  Builds the SDK libs + `vtx_cli` in Release mode and installs into `./dist`.  Removes the build/release script asymmetry between Windows and Linux
+
+### Changed
+
+- **repo layout**: all five build/clean/release wrappers moved from the repo root into `scripts/` (`build_sdk.bat`, `build_sdk.sh`, `clean.bat`, `clean.sh`, `release_sdk.bat`).  Each script now `cd`s to the repo root internally so invocations like `./scripts/build_sdk.sh` or `scripts\build_sdk.bat` work from any working directory.  Documentation references (README, CONTRIBUTING, docs/BUILD.md) updated accordingly
+- **repo layout**: `reports/benchmarks/` renamed to `docs/benchmarks/` to signal that the committed baseline outputs are reference documentation (co-located with `docs/PERFORMANCE.md` which narrates them) rather than stray CI artefacts.  `reports/` directory removed.  References in `docs/PERFORMANCE.md`, `docs/BUILD.md`, and the benchmark write-ups updated
+
 ## [0.1.0] - 2026-04-24
 
 ### Added

CONTRIBUTING.md

@@ -18,7 +18,7 @@ cmake --build build --config Release --parallel
 Or use the provided script:
 
 ```bat
-build_sdk.bat
+scripts\build_sdk.bat
 ```
 
 ## Code Style

README.md

@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/ZenosInteractive/VTX/actions/workflows/build.yml/badge.svg)](https://github.com/ZenosInteractive/VTX/actions/workflows/build.yml)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue?logo=apache&logoColor=white)](LICENSE)
-[![Release](https://img.shields.io/github/v/release/ZenosInteractive/VTX?logo=github&label=Release)](https://github.com/ZenosInteractive/VTX/releases)
+[![Release](https://img.shields.io/github/v/release/ZenosInteractive/VTX?include_prereleases&logo=github&label=Release)](https://github.com/ZenosInteractive/VTX/releases)
 [![C++20](https://img.shields.io/badge/C%2B%2B-20-00599C?logo=cplusplus&logoColor=white)](#requirements)
 [![Docs](https://img.shields.io/badge/Docs-Wiki-blue?logo=gitbook&logoColor=white)](https://github.com/ZenosInteractive/VTX/wiki)
 [![Website](https://img.shields.io/badge/Website-zenosinteractive.com-B870FB?logoColor=white)](https://www.zenosinteractive.com/)
@@ -28,7 +28,7 @@ cmake --build build --config Release --parallel
 cmake --install build --config Release --prefix dist
 ```
 
-Other build paths (vcpkg, CMake presets, the `build_sdk.bat` one-shot wrapper) in [Getting Started](https://github.com/ZenosInteractive/VTX/wiki/Getting-Started).
+Other build paths (vcpkg, CMake presets, the `scripts/build_sdk.bat` one-shot wrapper) in [Getting Started](https://github.com/ZenosInteractive/VTX/wiki/Getting-Started).
 
 ### Write a replay
 

docs/BUILD.md

@@ -117,23 +117,23 @@ sudo apt install libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-d
 ### Windows build script
 
 ```bat
-build_sdk.bat
+scripts\build_sdk.bat
 ```
 
 ### Linux / macOS build script
 
 ```bash
-./build_sdk.sh
+./scripts/build_sdk.sh
 ```
 
 Environment overrides:
 
 ```bash
-BUILD_TYPE=Debug ./build_sdk.sh
-SKIP_TESTS=1 ./build_sdk.sh
-CLEAN=1 ./build_sdk.sh
-JOBS=16 ./build_sdk.sh
-INSTALL_PREFIX=/opt/vtx ./build_sdk.sh
+BUILD_TYPE=Debug ./scripts/build_sdk.sh
+SKIP_TESTS=1 ./scripts/build_sdk.sh
+CLEAN=1 ./scripts/build_sdk.sh
+JOBS=16 ./scripts/build_sdk.sh
+INSTALL_PREFIX=/opt/vtx ./scripts/build_sdk.sh
 ```
 
 ### Manual CMake
@@ -295,7 +295,7 @@ cmake --build build-bench --target vtx_benchmarks --config Release --parallel
 
 # Run the full suite (writes JSON + console side-by-side for diffing over time)
 build-bench/bin/Release/vtx_benchmarks.exe \
-    --benchmark_out=reports/benchmarks/bench_$(date +%Y%m%d_%H%M%S).json \
+    --benchmark_out=docs/benchmarks/bench_$(date +%Y%m%d_%H%M%S).json \
     --benchmark_out_format=json \
     --benchmark_counters_tabular=true
 
@@ -309,7 +309,7 @@ Fixtures required at run time:
 - `samples/content/reader/{cs,rl,arena}/*.vtx` -- real replays; checked in.
 - `benchmarks/fixtures/synth_10k.vtx` -- small synthetic fixture generated by `vtx_sample_write` when `VTX_BUILD_BENCHMARKS=ON`.
 
-Narrative results (what the numbers mean, not just the tables) live in [`docs/PERFORMANCE.md`](PERFORMANCE.md). The raw output of the canonical run is committed under `reports/benchmarks/` as JSON + console text for regression tracking and graphing.
+Narrative results (what the numbers mean, not just the tables) live in [`docs/PERFORMANCE.md`](PERFORMANCE.md). The raw output of the canonical run is committed under `docs/benchmarks/` as JSON + console text for regression tracking and graphing.
 
 ## Running sanitizers locally
 

docs/PERFORMANCE.md

@@ -1,7 +1,7 @@
 # Performance
 
 > Numbers in this page come from the benchmark run on **2026-04-23** against `main` at commit `78b20f3`.
-> Raw data for that run (re-usable for graphing or regression tracking): [`reports/benchmarks/bench_20260423_162008.json`](../reports/benchmarks/bench_20260423_162008.json).
+> Raw data for that run (re-usable for graphing or regression tracking): [`docs/benchmarks/bench_20260423_162008.json`](benchmarks/bench_20260423_162008.json).
 
 ## At a glance
 
@@ -110,7 +110,7 @@ cmake --build build-bench --target vtx_benchmarks --config Release --parallel
 
 # Run the full suite (JSON + console output)
 build-bench/bin/Release/vtx_benchmarks.exe \
-    --benchmark_out=reports/benchmarks/bench_$(date +%Y%m%d_%H%M%S).json \
+    --benchmark_out=docs/benchmarks/bench_$(date +%Y%m%d_%H%M%S).json \
     --benchmark_out_format=json \
     --benchmark_counters_tabular=true
 
@@ -129,7 +129,7 @@ Fixtures required: CS, RL, and arena replays under `samples/content/reader/{cs,r
 
 | Path | What it is |
 |---|---|
-| [`reports/benchmarks/bench_20260423_162008.json`](../reports/benchmarks/bench_20260423_162008.json) | Raw google/benchmark JSON — reusable for graphing or regression tracking. |
-| [`reports/benchmarks/bench_20260423_162008.txt`](../reports/benchmarks/bench_20260423_162008.txt) | Console output as produced. |
+| [`docs/benchmarks/bench_20260423_162008.json`](benchmarks/bench_20260423_162008.json) | Raw google/benchmark JSON — reusable for graphing or regression tracking. |
+| [`docs/benchmarks/bench_20260423_162008.txt`](benchmarks/bench_20260423_162008.txt) | Console output as produced. |
 
 This page is the canonical narrative version of that data. If the benchmarks are re-run, update the numbers here (and commit the new raw outputs alongside) rather than maintaining a parallel per-run markdown report.