OpenROAD-flow-scripts/docs/toc.yml at 0eaa3fc75233e7adb9e4e6f4f754b02164c8871f · The-OpenROAD-Project/OpenROAD-flow-scripts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
root: index2
entries:

- file: user/UserGuide.md
  title: User Guide
  entries:
  - file: user/BuildWithPrebuilt.md
    title: Build Using Pre-built Binaries
  - file: user/BuildWithDocker
    title: Build Using Docker
    entries:
    - file: user/DockerShell.md
      title: Docker Shell utility
    - file: user/ClaudeCode.md
      title: Claude Code in Docker
  - file: user/BuildLocally.md
    title: Build Locally
  - file: user/BuildWithWSL.md
    title: Build Using WSL
  - file: user/FlowVariables.md
    title: Flow Variables
  - file: contrib/Metrics.md
    title: Metrics
  - file: user/InstructionsForAutoTuner.md
    title: AutoTuner

- file: Manpage.md
  title: Manpages

- file: contrib/GettingInvolved.md
  title: Getting Involved

- file: contrib/DeveloperGuide.md
  title: Developer's Guide
  entries:
  - file: contrib/GitGuide.md
    title: Git Quickstart

- file: contrib/CODE_OF_CONDUCT.md
  title: Code of Conduct

- file: user/FAQS.md
  title: FAQs

- file: tutorials/TutorialHome
  title: Tutorials
  entries:
  - file: tutorials/QuickstartGcdNangate45
    title: "Quickstart: gcd on nangate45 (Docker)"
  - file: tutorials/FlowTutorial
    title: Flow Tutorial
  - file: tutorials/Notebooks
    title: Running the OpenROAD Flow in Google Colab

- file: user/Flow_QoR_CI.md
  title: Flow QoR and CI Metrics
  entries:
  - file: user/QoRDashboard.md
    title: Using the OpenROAD Dashboard to track and analyze QoR
  - file: user/Jenkins.md
    title: Exploring CI Metrics with Jenkins