Commit Graph

378 Commits

Author SHA1 Message Date
Rafael Moresco
24834e0198 misc: update Readme
Signed-off-by: Rafael Moresco <rafaelmorescovieira@gmail.com>
2025-10-02 12:58:09 -03:00
Øyvind Harboe
7401995b29 bazel: OpenROAD has the canonical Bazel setup
megaboom that started first will copy-cat the setup
and the canonical home for the documentation will
be in OpenROAD.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-03-28 09:26:19 +01:00
luarss
c2d162e324 fix mermaid diagram README
Signed-off-by: luarss <jluar@precisioninno.com>
2024-11-17 15:13:23 +08:00
Song Luar
8229a95b89 [Docs] OR review (#4030)
* update docs
* grammar change

Signed-off-by: luarss <espsluar@gmail.com>
2024-01-16 11:28:18 -03:00
Song Luar
ac2f785949 [Docs] Fix prebuilt instructions and comments (#3971)
* edit comments
* add readme change

Signed-off-by: luarss <espsluar@gmail.com>
2023-09-13 09:52:46 -03:00
Song Luar
652d5be9a0 [Docs] Mermaid anchor fix test 2 (#3879)
* mermaid anchor fix

Signed-off-by: luarss <espsluar@gmail.com>
2023-08-28 12:54:13 -03:00
Song Luar
90f22d1599 update regression tests guide (#3744)
* update regression tests guide

Signed-off-by: luarss <espsluar@gmail.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
2023-07-31 12:31:52 -03:00
luarss
ff43c3b5a0 fix permalink
Signed-off-by: luarss <espsluar@gmail.com>
2023-07-21 22:21:18 +08:00
Song Luar
6fbc84f343 [Docs] Added OR messages glossary (#3506)
* Added OR messages glossary

Signed-off-by: luarss <espsluar@gmail.com>
Co-authored-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2023-07-19 12:42:31 -03:00
luarss
e42b079066 Fix gitguide broken links + remove unnecessary shields
Signed-off-by: luarss <espsluar@gmail.com>
2023-07-15 21:51:53 +08:00
Vitor Bandeira
dcfd631a4a Merge pull request #3618 from luarss/mermaidv2
[Docs] fix <br> tags
2023-07-14 11:20:39 -07:00
luarss
099bc84771 fix <br> tags
Signed-off-by: luarss <espsluar@gmail.com>
2023-07-15 02:14:22 +08:00
Song Luar
708046a650 [Docs] Sphinx book theme change (#3522)
* new docs theme

Signed-off-by: luarss <espsluar@gmail.com>
2023-07-14 14:50:52 -03:00
Song Luar
ba8f58d428 [Docs] Prototype for mermaid diagram (#3559)
* prototype for mermaid diagram

Signed-off-by: luarss <espsluar@gmail.com>
2023-07-14 13:52:32 -03:00
vijayank88
3d65037eb6 sync readme OR images
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-06-29 13:03:24 +00:00
Song Luar
b84325b100 [Docs] fix OR to ORFS build links, readme (#3461)
* fix OR to ORFS build links, readme
* fix checklinks
* restructured toc + removed OR tutorials
* shortened Releases section
* added instructions for local OR install
* Added page on error/warning codes provided by etc/find_messages
* readme update
* removed OR messages
* revert changes for toc and Makefile
* modified or/orfs descriptions

Signed-off-by: luarss <espsluar@gmail.com>
2023-06-29 07:54:12 -03:00
Vitor Bandeira
b68a780090 docs: change to make links work
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2023-06-08 15:11:32 -03:00
Vitor Bandeira
72c81fae62 docs: fix broken links
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2023-06-08 15:11:32 -03:00
Vitor Bandeira
276dab32e1 docs: README typo
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2023-06-08 15:11:32 -03:00
Vitor Bandeira
8c1ed45e8e docs: README break long line
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2023-06-08 14:32:38 -03:00
vijayank88
4e7cc31226 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-10 09:41:48 +00:00
vijayank88
eac7b834b0 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-09 07:44:45 +00:00
vijayank88
d4b2c8f8f2 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-05 10:31:50 +00:00
vijayank88
597d4868d5 READEME update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-04 09:57:58 +00:00
vijayank88
f73eeb40c1 READEME update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-04 09:56:13 +00:00
vijayank88
19981f1093 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-03 07:27:56 +00:00
vijayank88
8a74b13371 readme update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-02 12:39:03 +00:00
vijayank88
4572da7a95 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-02 09:44:15 +00:00
vijayank88
87155a4426 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-02 09:36:44 +00:00
vijayank88
be9f490ddf Hammer flow link included
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-04-18 05:30:48 +00:00
vijayank88
48ae17159b Hammer flow link included
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-04-17 06:32:04 +00:00
vijayank88
c37caa0169 READEME update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-04-14 04:17:12 +00:00
vijayank88
e626c746b6 READEME update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-04-14 04:10:42 +00:00
Øyvind Harboe
668d90ac1f setup: single source of truth and user oriented documentation
DependencyInstaller.sh is an implementation detail of user
setup procedures and Docker install scripts.

Also, remove some copy and paste from DepedencyInstaller.sh,
will quickly become quickly out of date. Use single source
of truth: the scripts themselves.

Major platforms are now supported and if some platform is not supported,
the user will discover it and hopefully submit PRs to solve quirks.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2023-04-12 12:24:44 +02:00
Vitor Bandeira
201979422e Merge branch 'master' into improve-reports
* master: (50 commits)
  Pre-empt user from running -local if root (#2731)
  CI: Update actions/checkout version
  doc original file
  odb: fix for swig 4.1.0
  odb: add missing call to setViaParams in lefin::via
  copyright
  revert illegal copyright/license in src copied from opensta
  fix missing bsd license headers
  gpl: properly account for partially overlapped site as fully unusable
  gpl: add density & overflow heatmap for debugging
  gui: add HeatMapDataSource::getBounds to stub_heatMap.cpp
  gui: allow customization of the heatmap bounds
  drt: clang-format again
  drt: remove unnecessar check over getBestRouteConnFigs
  drt: remove unnecessary check and fix typo
  drt: clang-format
  drt: fix error message
  rcx: rm more dead code
  odb: add dbWireGraph::Node::setObject
  gui: fix PR feedback
  ...
2023-02-03 22:10:32 -03:00
habibayassin
6d4b599030 Pre-empt user from running -local if root (#2731)
* check if root while running local
* add limitation in docs
* add -common and -base flags
* support in dockerhelper

Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Signed-off-by: habibayassin <habibayassin@aucegypt.edu>

* etc: simplify swig download
* etc: DockerHelper push only CI images
* etc: revert spdlog version
* etc: use sha for docker tests

Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>

---------

Signed-off-by: habibayassin <habibayassin@aucegypt.edu>
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Co-authored-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
2023-02-03 04:03:38 -03:00
habibayassin
058df11a43 log file per build dir
Signed-off-by: habibayassin <habibayassin@aucegypt.edu>
2023-01-30 23:27:15 +00:00
habibayassin
9928e30d27 improve issue reporting
Signed-off-by: habibayassin <habibayassin@aucegypt.edu>
2023-01-30 22:47:06 +00:00
vijayank88
e365549cfd move GF180 to public PDK
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-01-05 05:45:22 +00:00
habibayassin
2066241420 Unify options for installing dependencies (#2606)
* merge dev and runtime

Signed-off-by: habibayassin <habibayassin@aucegypt.edu>
2022-12-27 16:04:02 -03:00
Vitor Bandeira
495d65df48 docs: fix header levels
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
2022-12-24 09:41:17 -03:00
Vitor Bandeira
c85407953d docs: make usage of sudo more clear
Signed-off-by: Vitor Bandeira <vitor.vbandeira@gmail.com>
2022-10-04 10:11:07 -03:00
RuijiaoSun
633a739693 Reword and CUDA message added
Signed-off-by: RuijiaoSun <rsun.wr@gmail.com>
2022-08-14 17:07:39 +00:00
RuijiaoSun
fa8315f14f reword README.md
Signed-off-by: RuijiaoSun <rsun.wr@gmail.com>
2022-08-10 15:45:13 +00:00
RuijiaoSun
8fc16c10a5 README.md updated
Signed-off-by: RuijiaoSun <rsun.wr@gmail.com>
2022-08-09 22:30:57 +00:00
Austin Rovinski
b665f8e82c Typo, grammar, and other improvements to README
Signed-off-by: Austin Rovinski <rovinski@umich.edu>
2022-08-02 16:29:42 -04:00
vijayank88
7eedf207d2 OpenROAD main README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2022-06-24 07:40:17 +00:00
James Cherry
ccdd039aca README put back the text that describes what openroad is
Signed-off-by: James Cherry <cherry@parallaxsw.com>
2022-06-22 19:39:57 -07:00
vijayank88
9ce4276e3b OpenROAD main README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2022-06-22 05:57:54 +00:00
vijayank88
28be7fa030 OpenROAD main README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2022-06-22 05:56:12 +00:00