Skip to content

Commit 1bd97f1

Browse files
committed
[doc] update quick start on installing packages
1 parent f13addc commit 1bd97f1

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

doc/src/quickstart/index.rst

+23-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,29 @@ If you cloned the repository, you will need to set up the git submodules (if you
2323
2424
> git submodule init
2525
> git submodule update
26-
27-
VTR requires several system packages and Python packages to build and run the flow. Ubuntu users can install the required system packages using the following command (this works on Ubuntu 18.04, 20.04, 22.04 and 24.04, but you may require different packages on other Linux distributions). Our CI testing is on Ubuntu 24.04, so that is the best tested platform and recommended for development.
26+
27+
VTR requires several system and Python packages to build and run the flow.
28+
Ubuntu users can install the required system packages using the provided script or
29+
the command below. This setup works on Ubuntu 18.04, 20.04, 22.04, and 24.04, but note
30+
that some packages (such as ``clang-format-18``) are only available by default on Ubuntu 24.04.
31+
On older versions, this package will not be installed unless you manually add the appropriate
32+
LLVM APT repository.
33+
34+
To install ``clang-format-18`` on older Ubuntu versions (e.g., 20.04 or 22.04), you must add the
35+
LLVM repository manually:
36+
37+
.. code-block:: bash
38+
39+
sudo apt install wget gnupg lsb-release
40+
wget https://apt.llvm.org/llvm.sh
41+
chmod +x llvm.sh
42+
sudo ./llvm.sh 18
43+
44+
After that, you can install ``clang-format-18`` using:
45+
46+
.. code-block:: bash
47+
48+
sudo apt install clang-format-18
2849
2950
.. code-block:: bash
3051

0 commit comments

Comments
 (0)