Skip to content

Commit 7c9c844

Browse files
committed
Add instructions on initializing submodules
1 parent ce30051 commit 7c9c844

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

BUILDING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33

44
## Setting up Your Environment
55

6+
If you cloned the repository you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
7+
8+
.. code-block:: bash
9+
10+
> git submodule init
11+
> git submodule update
612

713
VTR requires several system packages. From the top-level directory, run the following script to install the required packages on a modern Debian or Ubuntu system:
814

doc/src/quickstart/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ The first step is to `download VTR <https://verilogtorouting.org/download/>`_ an
1717

1818
Environment Setup
1919
-----------------
20+
If you cloned the repository you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
21+
22+
.. code-block:: bash
23+
24+
> git submodule init
25+
> git submodule update
26+
2027
VTR requires several system packages and Python packages to build and run the flow. You can install the required system packages using the following command (this works on Ubuntu 18.04, 20.04 and 22.04, but you may require different packages on other Linux distributions). Our CI testing is on Ubuntu 22.04, so that is the best tested platform and recommended for development.
2128

2229
.. code-block:: bash

0 commit comments

Comments
 (0)