Skip to content

Commit

Permalink
docs: update name
Browse files Browse the repository at this point in the history
  • Loading branch information
vvbandeira committed Apr 30, 2021
1 parent aa3bced commit ca4eae5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
4 changes: 2 additions & 2 deletions LICENSE_BUILD_RUN_SCRIPTS
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
The OpenROAD-flow repository (build and run scripts) has a BSD 3-Clause License with its text below.
The OpenROAD-flow-scripts repository (build and run scripts) has a BSD 3-Clause License with its text below.
The flow relies on several tools, platforms and designs that each have their own licenses.

The license below applies ***only*** to the build and run scripts, not the OpenROAD tools.
See the README.md file LICENSE section for details on the location of each components' individual license.

License for Build and Run scripts in the OpenROAD-flow repository only :
License for Build and Run scripts in the OpenROAD-flow-scripts repository only :

BSD 3-Clause License

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ the docker build:
```
3. Start an interactive shell in a docker container using your user credentials
```
docker run -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow/platforms:/OpenROAD-flow/flow/platforms:ro openroad/flow bash
docker run -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow/platforms:/OpenROAD-flow-scripts/flow/platforms:ro openroad/flow-scripts
```
4. Update your container environment
```
Expand Down
5 changes: 3 additions & 2 deletions build_openroad.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ function usage() {
NICE=""
PROC=`nproc`
COPY_PLATFORMS="NO"
DOCKER_TAG="openroad/flow-scripts"

# Parse arguments
while (( "$#" )); do
Expand Down Expand Up @@ -77,7 +78,7 @@ done

# Choose install method
if [ -z ${BUILD_METHOD+x} ] && which docker &> /dev/null; then
echo "[INFO][FLOW-0000] using docker build method. This will create a docker image tagged 'openroad/flow'"
echo "[INFO][FLOW-0000] using docker build method. This will create a docker image tagged '${DOCKER_TAG}'"
build_method="DOCKER"
else
echo "[INFO][FLOW-0000] using local build method. This will create binaries at tools/build/"
Expand Down Expand Up @@ -124,7 +125,7 @@ if [ "$build_method" == "DOCKER" ]; then
cp .dockerignore{,.bak}
sed -i '/flow\/platforms/d' .dockerignore
fi
docker build -t openroad/flow -f Dockerfile .
docker build -t ${DOCKER_TAG} -f Dockerfile .
if [ "$COPY_PLATFORMS" == "YES" ]; then
mv .dockerignore{.bak,}
fi
Expand Down
8 changes: 4 additions & 4 deletions flow/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

## OpenROAD-flow
## OpenROAD-flow-scripts
![alt text](docs/flow.png "flow")
<!-- Original source at: https://docs.google.com/drawings/d/1XGPD7g_X3Pna87XtBf6EB_kCXerGPSeKEWGPO_Q-Sb4 -->

Expand Down Expand Up @@ -37,14 +37,14 @@ and limitations, but it will take time.


## Platforms
OpenROAD-flow supports Verilog to GDS for the following open platforms:
OpenROAD-flow-scripts supports Verilog to GDS for the following open platforms:
* Nangate45 / FreePDK45

These platforms have a permissive license which allows us to redistribute the
PDK and OpenROAD platform-specific files. The platform files and license(s) are
located in `platforms/{platform}`.

OpenROAD-flow also supports the following commercial platforms:
OpenROAD-flow-scripts also supports the following commercial platforms:
* TSMC65LP
* GF14 (in progress)

Expand All @@ -58,7 +58,7 @@ about the design. See sample configurations in the `design` directory.

### Adding a New Platform
At this time, we recommend looking at [`nangate45`](platforms/nangate45) as an
example of how to set up a new platform for OpenROAD-flow.
example of how to set up a new platform for OpenROAD-flow-scripts.

## Implement the Design
Run `make` to perform Verilog to GDS. The final output will be located at
Expand Down

0 comments on commit ca4eae5

Please sign in to comment.