diff --git a/Brewfile b/Brewfile new file mode 100644 index 00000000..b4f025b6 --- /dev/null +++ b/Brewfile @@ -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" diff --git a/README.md b/README.md index 4aea9416..328559e5 100644 --- a/README.md +++ b/README.md @@ -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 adhere to the GPL license requirements. However, OpenSTA is not 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. Removing copyright and license notices from OpenSTA sources (or any @@ -82,7 +82,7 @@ OpenSTA is built with CMake. ### 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. ``` @@ -203,10 +203,13 @@ 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. +The XCode versions of Tcl, Flex and Bison cannot be used to build OpenSTA. +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. @@ -251,12 +254,12 @@ case directory. Contributors must sign the Contributor License Agreement (doc/CLA.txt) 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. Contributions that claim 4% performance improvements in OpenROAD flow 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, abseil and Intel TBB will not be accepted.