From ea664144964091f3cefea484a118db55e610975d Mon Sep 17 00:00:00 2001 From: Stefan Koelle Date: Mon, 10 Aug 2026 21:21:26 +0200 Subject: [PATCH] fix AGENTS.md --- agents.md => AGENTS.md | 10 +++++----- PLAN.md | 2 +- README.md | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) rename agents.md => AGENTS.md (97%) diff --git a/agents.md b/AGENTS.md similarity index 97% rename from agents.md rename to AGENTS.md index db425a1..85b9ca0 100644 --- a/agents.md +++ b/AGENTS.md @@ -16,7 +16,7 @@ The implementation is split into focused modules (files) under the `MarcerGameDv - MarcerGameDvdLauncher/HatariLauncher.cs: Responsible for validating the Hatari executable and starting Hatari with the configured argument template (replaces `{cfg}` and `{zip}`). - MarcerGameDvdLauncher/UIErrorService.cs: Centralized UI error presentation using the console message helper. -Note: This overview is intentionally concise. For behavioral changes (navigation, color scheme, launch command or config schema), update this file (agents.md) and README.md as required by project policy. +Note: This overview is intentionally concise. For behavioral changes (navigation, color scheme, launch command or config schema), update this file (AGENTS.md) and README.md as required by project policy. **Note for Automated Tests/CI:** The Launcher cannot be executed or tested via `start.cmd` from this environment (build system, automation agent) since no Windows console environment is present. For release workflows and developer validation, it is ALWAYS required to do a manual test run via start.cmd per documentation and policy before delivery. @@ -24,7 +24,7 @@ The Launcher cannot be executed or tested via `start.cmd` from this environment - Pushing a tag (`v*`) triggers the GitHub Action workflow (`.github/workflows/release.yml`). - The workflow builds platform-specific artifacts (Windows, Linux, macOS), generates release notes from git log, and creates a GitHub Release with all ZIPs attached. - Developer steps for a release: - 1. Ensure `README.md` and `agents.md` are up to date. + 1. Ensure `README.md` and `AGENTS.md` are up to date. 2. Commit all changes. 3. Create and push a tag: `git tag v{version} && git push origin v{version}`. 4. The GitHub Action handles the rest (build, ZIP, release notes, GitHub Release). @@ -32,14 +32,14 @@ The Launcher cannot be executed or tested via `start.cmd` from this environment Additional policy: -- README.md must be written in English. Any functional change that affects usage, configuration, or behavior MUST update README.md in English immediately after the change. If there are consequential changes to developer-facing policies, build steps, or requirements, `agents.md` must be updated as well. +- README.md must be written in English. Any functional change that affects usage, configuration, or behavior MUST update README.md in English immediately after the change. If there are consequential changes to developer-facing policies, build steps, or requirements, AGENTS.md must be updated as well. Developer note: Visual Studio Solution - A Visual Studio solution file exists at the repository root: `marcer-gamedvd-launcher.sln`. Developers may open this solution in Visual Studio to work on the project, debug and build from the IDE. The solution references `MarcerGameDvdLauncher\MarcerGameDvdLauncher.csproj` and includes Debug and Release configurations. Use `build.cmd` (Windows) or `build.sh` (Linux) and `start.cmd` for consistent command-line builds/releases as described elsewhere in this document. With this, it is ensured that binary/release files never end up in git, and the release process is always traceable and performed exclusively manually in the web interface. -# Requirements for the Marcer GameDVD Launcher (agents.md) +# Requirements for the Marcer GameDVD Launcher (AGENTS.md) ## Basic Function / Purpose The console launcher is meant for browsing a games directory and can launch ZIP files with the Hatari emulator under Windows. Control is exclusively via keyboard in the console window. @@ -85,7 +85,7 @@ The console launcher is meant for browsing a games directory and can launch ZIP - After each build for a release, the entire build output directory (`bin/Release/net10.0/`) must be zipped in the `release/` directory, and the ZIP must be uploaded as a release asset in Gitea. - For every release, a Release Notes file must be maintained that summarizes all changes, bugfixes, and new features in that version; Release Notes must be provided with the release asset. - - **IMPORTANT:** With any functional change to the launcher, BOTH this file (agents.md) AND the README.md must always be updated and kept current. Immediately after, a successful build must be executed. This is mandatory for all development on the project. + - **IMPORTANT:** With any functional change to the launcher, BOTH this file (AGENTS.md) AND the README.md must always be updated and kept current. Immediately after, a successful build must be executed. This is mandatory for all development on the project. --- diff --git a/PLAN.md b/PLAN.md index 93f59f5..b576650 100644 --- a/PLAN.md +++ b/PLAN.md @@ -42,7 +42,7 @@ Ziel: Das Repo aufräumen (Doku, Code, Config) - [ ] `MenuRenderer` bekommt optional passende `AppColorConfig` (Konstruktor-Injection); `GetColorForEntry`/`GetColors` nutzen Config statt Konstanten. - [ ] Falls Config-Werte fehlen → heutiges Verhalten beibehalten (fallback). -- [ ] Doku synchronisieren: README + agents.md Farbtabellen auf Config-Felder verlinken. +- [ ] Doku synchronisieren: README + AGENTS.md Farbtabellen auf Config-Felder verlinken. - [ ] Beispielwerte ins `launcher.config.example.json` aufnehmen. ### 2b. Benutzer-Config (User-Config) – entschieden diff --git a/README.md b/README.md index 5473c3e..7c27732 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ Releases are automated via GitHub Actions. When a tag matching `v*` is pushed, t 3. Creates a GitHub Release with all ZIPs attached **To create a release:** -1. Ensure `README.md` and `agents.md` are up to date. +1. Ensure `README.md` and `AGENTS.md` are up to date. 2. Commit all changes. 3. Create and push a tag: `git tag v{version} && git push origin v{version}`. 4. The GitHub Action handles the rest. @@ -147,6 +147,6 @@ Releases are automated via GitHub Actions. When a tag matching `v*` is pushed, t This launcher was built for the [Marcer GameDVD](https://www.facebook.com/groups/360493904888475/) community on Facebook. If you have questions, suggestions, or want to discuss Hatari and Atari ST gaming, join the group! ## Notes -- Full requirements, features and build rules are always up to date in `agents.md`. -- After every code or feature change and every release, README.md and agents.md must be reviewed and kept up to date. -- For every release, release notes **must** be present listing all changes and bugfixes; this is required by agents.md! +- Full requirements, features and build rules are always up to date in `AGENTS.md`. +- After every code or feature change and every release, README.md and AGENTS.md must be reviewed and kept up to date. +- For every release, release notes **must** be present listing all changes and bugfixes; this is required by AGENTS.md!