Skip to content

Commit 958d4e9

Browse files
committed
docs: add quick-run section to doc.md
1 parent 0668171 commit 958d4e9

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

doc.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Canonical end-to-end guides (these are what we expect users to follow):
88
This `doc.md` is a “current status” handoff that ties together the 4 branches,
99
their pairing rules, gating, and known limitations/results.
1010

11+
Note: upstream `.gitignore` ignores `doc.md`, but in these surrogate branches the
12+
file is intentionally tracked (gitignore does not apply to tracked files).
13+
1114
## Current branch set (precisedanon)
1215

1316
The deliverable is **four branches total** (two repos × normal/rebased):
@@ -39,6 +42,35 @@ Pairing rules:
3942
- `orfs-surrogate-normal``openroad-surrogate-normal`
4043
- `orfs-surrogate-rebased``openroad-surrogate-rebased`
4144

45+
## Quick run (normal vs rebased)
46+
47+
Normal:
48+
49+
```bash
50+
git checkout orfs-surrogate-normal
51+
git submodule update --init --recursive
52+
./build_openroad.sh --local
53+
54+
# Baseline logs (recommended for calibration)
55+
make -C flow finish DESIGN_CONFIG=designs/<platform>/<design>/config.mk
56+
57+
# Surrogate autotune (example)
58+
make -C flow surrogate_autotune DESIGN_CONFIG=designs/<platform>/<design>/config.mk \
59+
SURROGATE_VALIDATE=1 SURROGATE_VALIDATE_N=14
60+
```
61+
62+
Rebased:
63+
64+
```bash
65+
git checkout orfs-surrogate-rebased
66+
git submodule update --init --recursive
67+
./build_openroad.sh --local --openroad-args "-D ENABLE_SURROGATE=ON"
68+
69+
# Surrogate targets on this branch run OpenROAD with OPENROAD_ENABLE_SURROGATE=1
70+
make -C flow surrogate_autotune DESIGN_CONFIG=designs/<platform>/<design>/config.mk \
71+
SURROGATE_VALIDATE=1 SURROGATE_VALIDATE_N=14
72+
```
73+
4274
## What is shipped (ORFS surface area)
4375

4476
New `flow/Makefile` targets:

0 commit comments

Comments
 (0)