Skip to content

docs: add AGENTS.md with architecture and build/test instructions (issue #32) - #34

Merged
EndrII merged 2 commits into
mainfrom
task_32
Nov 12, 2026
Merged

EndrII merged 2 commits into
mainfrom
task_32

Conversation

@QuasarAppCI

Copy link
Copy Markdown
Member

Summary

Add AGENTS.md with the base rules for all AI agents working in this repository (issue #32).

The file contains everything the issue requires:

  • Project architecture — single-translation-unit C library (OpenSimplex2F.c/.h), the context-based API, the OpenSimplex2Interface/OpenSimplex2InterfaceC CMake targets, the QuasarApp CMake layer (submodule/CMake → QuasarApp/CMake) and its test target, the standalone GLSL/HLSL shader ports, and the MkDocs + Doxygen documentation site.
  • Project structure — a path-by-path table of the repository layout.
  • Maintainer — EndrII (Yankovich Andrei), QuasarApp Group DOO.
  • Contribution process — issue-driven workflow: task_<issue> branch strictly from main, labels (in progress → waiting-for-review), checklist comment updated in place, commit style, PR creation via gh CLI, CI gate.
  • Building and testing instructions — prerequisites table (CMake ≥ 3.19, MinGW on Windows, libpng, cqtdeployer), the exact step-by-step CMake commands CI runs, CMake options, the manual Makefile build, consumer CMakeLists.txt example, and how to run the OpenSimplex2tests executable (CMake test target, plain build path, Makefile build).

Verification

The documented commands were executed on this machine (Linux, GCC, Ninja, libpng 1.6.43, cqtdeployer on PATH):

$ cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
-- Found PNG: /usr/lib/x86_64-linux-gnu/libpng.so (found version "1.6.43")
-- Configuring done

$ cmake --build build --parallel 4
[4/4] Linking C executable tests/OpenSimplex2tests

$ cmake --build build --target test
OpenSimplex2F tests (seed 77374, image 512x512)
  [1/3] open_simplex_noise4 (3 octaves)  min=-0.633449 max= 0.698641 mean=-0.003433 -> test2d.png (103274 bytes) ... PASS
  [2/3] OpenSimplex2F_noise2             min=-0.999918 max= 0.999974 mean=  0.001072 -> test3d.png (211556 bytes) ... PASS
  [3/3] OpenSimplex2F_noise3_Classic     min=-0.996820 max= 0.996495 mean= 0.000300 -> test4d.png (185219 bytes) ... PASS
Result: 3/3 tests passed

Also verified that the binary paths cited in the doc exist: build/tests/OpenSimplex2tests (plain build) and Testing/OpenSimplex2/Application/bin/OpenSimplex2tests (deployed by the test target).

Closes #32.

…ution process and build/test instructions (issue #32)
@QuasarAppCI QuasarAppCI mentioned this pull request Nov 12, 2026
@EndrII
EndrII self-requested a review November 12, 2026 19:55

@EndrII EndrII left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

simplefy please.

@QuasarAppCI

Copy link
Copy Markdown
Member Author

Simplified AGENTS.md per the review: 236 -> 109 lines (commit 1dd8c8b). All 5 sections required by #32 are kept (architecture, structure, maintainer, contribution process, build + test instructions); verbose prose, redundant detail and duplicated build/test notes were trimmed. The documented commands were re-verified after the change: CMake build + test target -> 3/3 tests passed, make path also passes.

@EndrII
EndrII self-requested a review November 12, 2026 21:40
@EndrII
EndrII merged commit 570a0cb into main Nov 12, 2026
8 of 9 checks passed
@EndrII
EndrII deleted the task_32 branch November 12, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AGENTS documentation

2 participants