Skip to content

Commit a894a22

Browse files
Roveyclaude
andcommitted
docs: README as the product page; AGENTS.md for AI coding agents
The README now introduces the finished app: hero screenshot, download first, requirements, profiles, how the search works (with a diagram), the command line as a table and an FAQ. Developer material moved to docs/development.md. The agent instructions moved from CLAUDE.md to AGENTS.md, which most coding agents read; CLAUDE.md imports it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent 1a35f41 commit a894a22

6 files changed

Lines changed: 232 additions & 134 deletions

File tree

‎AGENTS.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# GPU Auto Optimizer
2+
3+
Instructions for AI coding agents working in this repository. A native C++20 Windows tool that tunes
4+
NVIDIA GPUs (power limit, core and memory offsets) through NVML and NVAPI, with a DX11 stress test.
5+
User-facing overview: `README.md`. Code layout, profiles and release process: `docs/development.md`.
6+
7+
## Hard requirement: English only
8+
9+
Everything in this repository is in English, without exception: code, identifiers, comments,
10+
CLI output and log lines, commit messages, branch names, PR titles and descriptions, specs,
11+
plans, README, `docs/`, test names and file names. This holds even when the conversation with
12+
the user is in another language — translate, never paste non-English text into the project.
13+
14+
## Build and test
15+
16+
`cmake` is not on `PATH`; use the one bundled with Visual Studio:
17+
18+
```powershell
19+
$bin = "C:\Program Files\Microsoft Visual Studio\18\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin"
20+
& "$bin\cmake.exe" --workflow --preset ci # configure, build Release, test
21+
& "$bin\cmake.exe" --build --preset debug; & "$bin\ctest.exe" --preset debug
22+
```
23+
24+
Everything we compile is `/W4 /WX`; fix warnings, do not suppress them.
25+
26+
## Layout
27+
28+
Two executables on one engine: `gao.exe` (CLI, `src/app/main.cpp`) and
29+
`GpuAutoOptimizer.exe` (window + tray + watchdog, `src/app/gui/`). Logic both
30+
need lives in `src/app/common.*`, never in either entry point.
31+
32+
## Rules the design depends on
33+
34+
- `src/core/` is pure logic: no `windows.h`, NVML, NVAPI or D3D headers. It reaches hardware
35+
only through `GpuControl` and callbacks, so CI tests it without a GPU.
36+
- Every hardware write is verified by reading it back; a mismatch is a failure. Any failed
37+
apply ends at stock.
38+
- The crash journal's `begin` line is flushed to disk before a clock candidate touches the
39+
hardware.
40+
- `src/hw/` is verified by hand on the reference RTX 4070 via `docs/hardware-checks.md`; record
41+
the results there.
42+
- Commands that write to the GPU need an elevated shell.

‎CLAUDE.md‎

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1 @@
1-
# GPU Auto Optimizer
2-
3-
## Hard requirement: English only
4-
5-
Everything in this repository is in English, without exception: code, identifiers, comments,
6-
CLI output and log lines, commit messages, branch names, PR titles and descriptions, specs,
7-
plans, README, `docs/`, test names and file names. This holds even when the conversation with
8-
the user is in another language — translate, never paste non-English text into the project.
9-
10-
## Build and test
11-
12-
`cmake` is not on `PATH`; use the one bundled with Visual Studio:
13-
14-
```powershell
15-
$bin = "C:\Program Files\Microsoft Visual Studio\18\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin"
16-
& "$bin\cmake.exe" --workflow --preset ci # configure, build Release, test
17-
& "$bin\cmake.exe" --build --preset debug; & "$bin\ctest.exe" --preset debug
18-
```
19-
20-
Everything we compile is `/W4 /WX`; fix warnings, do not suppress them.
21-
22-
## Layout
23-
24-
Two executables on one engine: `gao.exe` (CLI, `src/app/main.cpp`) and
25-
`GpuAutoOptimizer.exe` (window + tray + watchdog, `src/app/gui/`). Logic both
26-
need lives in `src/app/common.*`, never in either entry point.
27-
28-
## Rules the design depends on
29-
30-
- `src/core/` is pure logic: no `windows.h`, NVML, NVAPI or D3D headers. It reaches hardware
31-
only through `GpuControl` and callbacks, so CI tests it without a GPU.
32-
- Every hardware write is verified by reading it back; a mismatch is a failure. Any failed
33-
apply ends at stock.
34-
- The crash journal's `begin` line is flushed to disk before a clock candidate touches the
35-
hardware.
36-
- `src/hw/` is verified by hand on the reference RTX 4070 via `docs/hardware-checks.md`; record
37-
the results there.
38-
- Commands that write to the GPU need an elevated shell.
1+
@AGENTS.md

0 commit comments

Comments
 (0)