Skip to content

Commit 4d8bcc2

Browse files
authored
Use code blocks for command line instructions
The current format of the build file is quite illegible and poses difficulties for developers trying to quickly build. This commit helps resolve this by making it easier to simply copy the commands while also fixing legibility.
1 parent 5f20394 commit 4d8bcc2

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

BUILD.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The Release and Debug builds of RRA will be available in the build/release and b
3838

3939
### Building on Ubuntu
4040
Required dependencies can be installed as follows:
41-
41+
```bash
4242
sudo apt-get update
4343
sudo apt-get install build-essential python3 chrpath
4444
sudo apt-get install python3-pip
@@ -49,7 +49,7 @@ sudo apt-get install git-lfs
4949
sudo apt-get install python3-sphinx
5050
sudo apt-get install libxcb-xinerama0
5151
sudo apt-get install mesa-common-dev libglu1-mesa-dev
52-
52+
```
5353
Qt V5.15.2 can be installed using the Qt online installer available from the Qt 5.15.2 release page here: https://www.qt.io/blog/qt-5.15.2-released
5454
As an alternative, the Qt 5.12.6 offline installer can be used here: https://download.qt.io/archive/qt/5.12/5.12.6/ (the .run file) and installed
5555
to ~/Qt/Qt5.12.6 (the default of ~/Qt5.12.6 will not work).
@@ -61,23 +61,24 @@ the libraries in the post build step. If needed, the XCB library files (libxcb*)
6161
Suite download found at https://gpuopen.com/tools/.
6262

6363
Run the python pre_build.py in the build folder.
64-
65-
$ python3 pre_build.py
66-
64+
```bash
65+
python3 pre_build.py
66+
```
6767
Or run the pre_build.py script with the -qt option to specify another version of Qt (also use the --disable-extra-qt-lib-deploy flag since the XCB
6868
libraries aren't needed). For example:
69-
70-
$ python3 pre_build.py --qt 5.12.6 --disable-extra-qt-lib-deploy
71-
69+
```bash
70+
python3 pre_build.py --qt 5.12.6 --disable-extra-qt-lib-deploy
71+
```
7272
The pre_build.py script will construct the output folders and build the necessary makefiles.
7373
To build the release build, use:
74-
75-
$ make -j5 -C linux/make/release
76-
74+
```bash
75+
make -j5 -C linux/make/release
76+
```
7777
Similarly for the debug build, use:
78-
79-
$ make -j5 -C linux/make/debug
80-
78+
```bash
79+
make -j5 -C linux/make/debug
80+
```
8181
Alternatively, building can be done directly from the prebuild script with the --build option
82-
83-
$ python3 pre_build.py --build
82+
```bash
83+
python3 pre_build.py --build
84+
```

0 commit comments

Comments
 (0)