luke
/
OpenSTA
mirror of https://github.com/The-OpenROAD-Project/OpenSTA.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add `Brewfile`, recommend `brew bundle install`, small typo fixes (#226) 

* Add Brewfile, recommend `brew bundle install`, small typo fixes

* Small edit to README
This commit is contained in:
Akash Levy 2025-03-29 08:48:20 -07:00 committed by GitHub
parent 1d59a16efb
commit 0f8358c717
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Brewfile Normal file
View File

@ -0,0 +1,9 @@
brew "bison"
brew "cmake"
brew "eigen"
brew "flex"
brew "swig"
brew "tcl-tk@8"
tap "mht208/formal"
brew "mht208/formal/cudd"

17
README.md
View File

@ -62,7 +62,7 @@ OpenSTA is open source, meaning the sources are published and can be
compiled locally. Derivative works are supported as long as they compiled locally. Derivative works are supported as long as they
adhere to the GPL license requirements. However, OpenSTA is not adhere to the GPL license requirements. However, OpenSTA is not
supported by a public community of developers as many other open supported by a public community of developers as many other open
source projects are. The copyright and develpment are exclusive to source projects are. The copyright and development are exclusive to
Parallax Software. Parallax Software.
Removing copyright and license notices from OpenSTA sources (or any Removing copyright and license notices from OpenSTA sources (or any
@ -82,7 +82,7 @@ OpenSTA is built with CMake.
### Prerequisites ### Prerequisites
The build dependency versions are show below. Other versions may The build dependency versions are shown below. Other versions may
work, but these are the versions used for development. work, but these are the versions used for development.
``` ```
@ -203,10 +203,13 @@ docker run -i -v $HOME:/data OpenSTA
## Build on Macos/Darwin ## Build on Macos/Darwin
THe XCode versions of Tcl, Flex and Bison cannot be used to build OpenSTA. The XCode versions of Tcl, Flex and Bison cannot be used to build OpenSTA.
Use Homebrew to install them. Use Homebrew to install them. The following command installs the tools
required to build OpenSTA in the Brewfile.
brew install cmake swig flex bison tcl-tk zlib ```
brew bundle install
```
Set these variables before using cmake to cirumvent the Xcode versions. Set these variables before using cmake to cirumvent the Xcode versions.
@ -251,12 +254,12 @@ case directory.
Contributors must sign the Contributor License Agreement (doc/CLA.txt) Contributors must sign the Contributor License Agreement (doc/CLA.txt)
when submitting pull requests. when submitting pull requests.
All contributors should read doc/CodingGuidelines.txt for nodes on All contributors should read doc/CodingGuidelines.txt for notes on
making code that adheres to the existing naming and formatting style. making code that adheres to the existing naming and formatting style.
Contributions that claim 4% performance improvements in OpenROAD flow Contributions that claim 4% performance improvements in OpenROAD flow
scripts will largely be ignored. Small performance improvements scripts will largely be ignored. Small performance improvements
simply do not justify the time requied to audit and verify the changes. simply do not justify the time required to audit and verify the changes.
Contributions that add dependencies on external libraries like boost, Contributions that add dependencies on external libraries like boost,
abseil and Intel TBB will not be accepted. abseil and Intel TBB will not be accepted.