Skip to content

Commit 36d26e5

Browse files
committed
Clarified validation workflow docs
1 parent fd85c41 commit 36d26e5

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ For the full local proof bar used by this repository, run:
2323
./run_validation.sh
2424
```
2525

26+
## Beginner Ramp-Up
27+
28+
If you are new to Gates, use this path:
29+
30+
1. Build the `gates` binary and run `./build/gates --version`.
31+
2. Translate one curated example from `examples/` before trying your own input files.
32+
3. Run `./run_tests.sh` once you understand the basic translation path.
33+
4. Use `./run_validation.sh` as the full public proof bar before you treat a change as release-ready.
34+
5. Read [ROADMAP.md](ROADMAP.md) after that so you do not confuse supported behavior with planned future work.
35+
2636
## Example
2737

2838
Given this C input:
@@ -113,6 +123,16 @@ If native and Docker results disagree, the Docker path is the source of truth fo
113123

114124
`./run_validation.sh` configures the project, runs GoogleTest via CTest, smoke-generates VHDL from the curated positive examples in `examples/`, builds the Sphinx docs, and runs `cppcheck`.
115125

126+
## Building Documentation
127+
128+
Use the convenience wrapper below when you want just the Sphinx HTML output:
129+
130+
```bash
131+
./build_docs.sh
132+
```
133+
134+
The script configures `build/` automatically if it does not exist yet, then builds the `docs` CMake target. The authoritative release path is still `./run_validation.sh`, which exercises the docs build together with tests, smoke translation, and static analysis.
135+
116136
## Docker
117137

118138
Build an interactive development image:

0 commit comments

Comments
 (0)