Skip to content

Commit 97996a2

Browse files
authored
Merge pull request #2460 from verilog-to-routing/docker-image-doc
Add documentation for Docker images of vtr8 and VTR master
2 parents 4f08d52 + b5ee342 commit 97996a2

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,13 @@ _The following are changes which have been implemented in the VTR master branch
117117
### Deprecated
118118
* VPR's breadth-first router (use the timing-driven router, which provides supperiour QoR and Run-time)
119119

120+
### Docker Image
121+
* A docker image is available for VTR 8.0 release on mohamedelgammal/vtr8:latest. You can run it using the following commands:
122+
```
123+
$ sudo docker pull mohamedelgammal/vtr8:latest
124+
$ sudo docker run -it mohamedelgammal/vtr8:latest
125+
```
126+
120127
## v8.0.0-rc2 - 2019-08-01
121128

122129
### Changed

doc/src/vtr/get_vtr.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ The official VTR release is available from:
3131

3232
https://verilogtorouting.org/download
3333

34+
VTR Docker Image
35+
~~~~~~~~~~~~~~~~
36+
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:
37+
38+
.. code-block:: bash
39+
40+
> sudo docker pull mohamedelgammal/vtr-master:latest
41+
> sudo docker run -it mohamedelgammal/vtr-master:latest
42+
43+
3444
Release
3545
~~~~~~~
3646

0 commit comments

Comments
 (0)