Skip to content

Add documentation for Docker images of vtr8 and VTR master #2460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,13 @@ _The following are changes which have been implemented in the VTR master branch
### Deprecated
* VPR's breadth-first router (use the timing-driven router, which provides supperiour QoR and Run-time)

### Docker Image
* A docker image is available for VTR 8.0 release on mohamedelgammal/vtr8:latest. You can run it using the following commands:
```
$ sudo docker pull mohamedelgammal/vtr8:latest
$ sudo docker run -it mohamedelgammal/vtr8:latest
```

## v8.0.0-rc2 - 2019-08-01

### Changed
Expand Down
10 changes: 10 additions & 0 deletions doc/src/vtr/get_vtr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ The official VTR release is available from:

https://verilogtorouting.org/download

VTR Docker Image
~~~~~~~~~~~~~~~~
A docker image for VTR is available. This image provides all the required packages and python libraries required. However, this ease to compile and run comes at the cost of some runtime increase (<10%). To pull and run the docker image of latest VTR repository, you can run the following commands:

.. code-block:: bash

> sudo docker pull mohamedelgammal/vtr-master:latest
> sudo docker run -it mohamedelgammal/vtr-master:latest


Release
~~~~~~~

Expand Down