Commit Graph

25 Commits

Author SHA1 Message Date
Matt Liberty
2939447bf1 Merge pull request #9649 from alokkumardalei-wq/docs_depenency
docs: Add DependencyInstaller.sh functionalities(-local and -prefix) to Build.md
2026-04-15 15:17:19 +00:00
Øyvind Harboe
7d371a36ee bazel: add top-level aliases for install and tarfile
The install and tarfile targets were moved to //packaging/ to isolate
@rules_pkg loads from downstream consumers, but this broke the
user-facing //:install and //:tarfile targets. Add alias() rules at
the top level to restore the public API while keeping the implementation
in the packaging/ subdirectory.

Update documentation to use //:install and //:tarfile. Also fix
docs/user/Bazel.md which incorrectly listed rules_shell as a
dev_dependency (it is loaded in the root BUILD.bazel).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-04-14 18:12:35 +02:00
alokkumardalei-wq
5cd31076b7 docs: Update dependency install instructions to use setup.sh
Signed-off-by: alokkumardalei-wq <alokkumardalei2@gmail.com>
2026-04-14 09:19:02 +05:30
alokkumardalei-wq
8eecd0690c fix cmakeOptions eval bug and add missing help flag
Signed-off-by: alokkumardalei-wq <alokkumardalei2@gmail.com>
2026-04-14 09:09:27 +05:30
alokkumardalei-wq
f0795a1019 docs: Add DependencyInstaller help to Build.md and support -local/-prefix in Build.sh
Signed-off-by: alokkumardalei-wq <alokkumardalei2@gmail.com>
2026-04-14 09:07:45 +05:30
Sahil Jaiswal
218e898f8e build: Improve macOS build and dependency installation
ref #9895

- Add macOS venv setup documentation
- Improve Build.sh with better package validation and env config
- Update DependencyInstaller.sh for macOS (threads, icu4c, tcl-tk@8)
- Use pip instead of pipx

Signed-off-by: Sahil Jaiswal <jaiswalsahil7741@gmail.com>
2026-04-12 15:51:46 +05:30
Vitor Bandeira
2464c8cb54 bazel: fix Bazel target paths in install script and docs
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2026-03-31 18:06:38 +00:00
Friedrich Beckmann
54a0fe8e24 bazel: use pkg_tar for the install procedure
I updated the install procedure to use the pkg_tar
module. The install works as before, but now you
can also install optionally to another location.

Closes: #9635

Signed-off-by: Friedrich Beckmann <friedrich.beckmann@tha.de>
2026-03-06 06:54:32 +01:00
Øyvind Harboe
6effc356fa bazel: fix duplicate version output and caching
- Change stamp = True to stamp = -1 so the genrule only stamps
  with --config=release (--stamp), not on every build. This keeps
  dev builds deterministic and cache-safe.
- Set OPENROAD_GIT_DESCRIBE to empty string instead of duplicating
  OPENROAD_VERSION (which caused "26Q1-... 26Q1-..." in the banner).
- Remove OPENROAD_GIT_DESCRIBE from OPENROAD_DEFINES to avoid macro
  redefinition with the genrule-generated Version.hh.
- Document version stamping in Bazel.md and Build.md.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-01 18:55:28 +01:00
Øyvind Harboe
4bee233fa1 bazel: add bazelisk run :install
Also: Apply suggestions from code review

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-01-28 12:08:19 +01:00
JingrenWang
c60c7bf738 Refactor(Binary): Specify binary path
Signed-off-by: JingrenWang <wjrforcyber@163.com>
2025-09-12 07:05:54 +08:00
Vitor Bandeira
2b33059d15 docs: move install instructions
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2025-02-05 18:36:17 +00:00
Vitor Bandeira
bcd0cc31c6 docs: preferred way to build with Build.sh
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2025-02-05 14:07:14 +00:00
Song Luar
0aff237a5b [Docs] OR Review 2 (#4159)
* update os matrix and reorder build instructions to put prebuilt>docker>local
* prototype for tabbed content for openroad APIs
* add sphinx_tabs
* Updated docs requirements.txt
* Now displays OpenROAD APIs nicely.

Signed-off-by: luarss <39641663+luarss@users.noreply.github.com>
Signed-off-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
Signed-off-by: Song Luar <espsluar@gmail.com>
Co-authored-by: Vitor Bandeira <vvbandeira@users.noreply.github.com>
2024-08-27 10:36:18 -03:00
Matt Liberty
ece2ab3e8c Merge pull request #4910 from luarss/manpage_docs
[Docs] Add manpages to Readthedocs
2024-04-26 13:37:43 -07:00
luarss
a88ce00b02 update install instructions
Signed-off-by: luarss <39641663+luarss@users.noreply.github.com>
2024-04-13 11:49:10 +08:00
luarss
d4bce64ba7 add sudo to make install instructions docs
Signed-off-by: luarss <39641663+luarss@users.noreply.github.com>
2024-04-09 09:44:47 +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
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
Ian Yurychuk
a16959c456 Update Build.md with ASAN instructions
Signed-off-by: Ian Yurychuk <76540445+Iyury1@users.noreply.github.com>
2023-06-06 22:20:14 -06:00
vijayank88
4e7cc31226 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-10 09:41:48 +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
87155a4426 README update
Signed-off-by: vijayank88 <paruthi143@gmail.com>
2023-05-02 09:36:44 +00:00