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

readme 

Signed-off-by: James Cherry <cherry@parallaxsw.com>
This commit is contained in:
James Cherry 2025-01-25 10:01:09 -07:00
parent 1f595c0589
commit eb7fe84055
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -98,9 +98,6 @@ bison 3.8.2 3.8.2
flex 2.6.4 2.6.4
```
Note that flex versions before 2.6.4 contain 'register' declarations that
are illegal in c++17.
External library dependencies:
```
Ubuntu Darwin License
@ -111,12 +108,11 @@ zLib 1.2.5 1.2.8 zlib optional
```
The [TCL readline library](https://tclreadline.sourceforge.net/tclreadline.html)
links the GNU readline library to the TCL interpreter for command line editing
On OSX, Homebrew does not support tclreadline, but the macports system does
(see https://www.macports.org). To enable TCL readline support use the following
Cmake option: See (https://tclreadline.sourceforge.net/) for TCL readline
documentation. To change the overly verbose default prompt, add something this
to your ~/.sta init file:
links the GNU readline library to the TCL interpreter for command line
editing To enable TCL readline support use the following Cmake option:
See (https://tclreadline.sourceforge.net/) for TCL readline
documentation. To change the overly verbose default prompt, add
something this to your ~/.sta init file:
```
if { ![catch {package require tclreadline}] } {
@ -148,7 +144,7 @@ make
You can use the "configure --prefix" option and "make install" to install CUDD
in a different directory.
### Installing with CMake
### Building with CMake
Use the following commands to checkout the git repository and build the
OpenSTA library and excutable.
@ -206,6 +202,24 @@ interactively.
docker run -i -v $HOME:/data OpenSTA
```
## Build on Macos/Darwin
THe XCode versions of Tcl, Flex and Bison cannot be used to build OpenSTA.
Use Homebrew to install them.
brew install cmake swig flex bison tcl-tk zlib
Set these variables before using cmake to cirumvent the Xcode versions.
# flex/bison override apple version
export PATH="$(brew --prefix bison)/bin:${PATH}"
export PATH="$(brew --prefix flex)/bin:${PATH}"
export CMAKE_INCLUDE_PATH="$(brew --prefix flex)/include"
export CMAKE_LIBRARY_PATH="$(brew --prefix flex)/lib;$(brew --prefix bison)/lib"
Homebrew does not support tclreadline, but the macports system does
(see https://www.macports.org).
## Bug Reports
Use the Issues tab on the github repository to report bugs.