Skip to content

Commit edcc115

Browse files
authored
Merge pull request #2 from Doomsdayrs/patch-1
Update BUILD.md formatting
2 parents 9c9ab5c + acd2c65 commit edcc115

File tree

1 file changed

+28
-23
lines changed

1 file changed

+28
-23
lines changed

BUILD.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
### Download Source code
44

55
Clone the project radeon_raytracing_analyzer from github.com
6-
6+
```bash
77
git clone https://github.com/GPUOpen-Tools/radeon_raytracing_analyzer.git
8+
```
89

910
### Building on Windows
1011
As a preliminary step, make sure that you have the following installed on your system:
@@ -13,14 +14,14 @@ As a preliminary step, make sure that you have the following installed on your s
1314
* Qt® 5 or above (5.15.2 is the default and recommended).
1415
* Visual Studio® 2015 or above (2019 is the default).
1516

16-
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
17-
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/
17+
Qt V5.15.2 can be installed using the Qt online installer available from the Qt 5.15.2 release page [here][qt-online].
18+
As an alternative, the Qt 5.12.6 offline installer can be used [here][qt-offline].
1819
Qt should be installed to the default location (C:\Qt\Qt5.xx.x).
1920
Be sure to select msvc2017/msvc2019 64-bit during Qt installation, depending on the compiler you decide to use.
2021
A reboot is required after Qt is installed.
2122

22-
CMake can be downloaded from (https://cmake.org/download/).
23-
Python (V3.x) can be downloaded from (https://www.python.org/). To build the documentation from Visual Studio, the Sphinx Python Document Generator is needed.
23+
CMake can be downloaded from [here](https://cmake.org/download/).
24+
Python (V3.x) can be downloaded from [here](https://www.python.org/). To build the documentation from Visual Studio, the Sphinx Python Document Generator is needed.
2425
This can be installed once Python is installed, as follows:
2526
* Open a command prompt and navigate to the scripts folder in the python install folder. Then type these 2 commands:
2627
* pip install -U sphinx
@@ -38,7 +39,7 @@ The Release and Debug builds of RRA will be available in the build/release and b
3839

3940
### Building on Ubuntu
4041
Required dependencies can be installed as follows:
41-
42+
```bash
4243
sudo apt-get update
4344
sudo apt-get install build-essential python3 chrpath
4445
sudo apt-get install python3-pip
@@ -49,35 +50,39 @@ sudo apt-get install git-lfs
4950
sudo apt-get install python3-sphinx
5051
sudo apt-get install libxcb-xinerama0
5152
sudo apt-get install mesa-common-dev libglu1-mesa-dev
52-
53-
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
54-
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
53+
```
54+
Qt V5.15.2 can be installed using the Qt online installer available from the Qt 5.15.2 release page [here][qt-online].
55+
As an alternative, the Qt 5.12.6 offline installer can be used [here][qt-offline] (the .run file) and installed
5556
to ~/Qt/Qt5.12.6 (the default of ~/Qt5.12.6 will not work).
5657

5758
XCB libraries are required for Qt v5.15.x (they are not needed for older Qt versions). By default, the CMake configuration will attempt to copy
5859
these files from the Qt lib folder. If these files are installed elsewhere on the system or an older version of Qt is being used to build RRA,
5960
the --disable-extra-qt-lib-deploy pre_build.py script argument may be used. This will prevent the build configuration scripts from attempting to copy
6061
the libraries in the post build step. If needed, the XCB library files (libxcb*) can be obtained from the /lib folder of the Radeon Developer Tool
61-
Suite download found at https://gpuopen.com/tools/.
62+
Suite download found [here](https://gpuopen.com/tools/).
6263

6364
Run the python pre_build.py in the build folder.
64-
65-
$ python3 pre_build.py
66-
65+
```bash
66+
python3 pre_build.py
67+
```
6768
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
6869
libraries aren't needed). For example:
69-
70-
$ python3 pre_build.py --qt 5.12.6 --disable-extra-qt-lib-deploy
71-
70+
```bash
71+
python3 pre_build.py --qt 5.12.6 --disable-extra-qt-lib-deploy
72+
```
7273
The pre_build.py script will construct the output folders and build the necessary makefiles.
7374
To build the release build, use:
74-
75-
$ make -j5 -C linux/make/release
76-
75+
```bash
76+
make -j5 -C linux/make/release
77+
```
7778
Similarly for the debug build, use:
78-
79-
$ make -j5 -C linux/make/debug
80-
79+
```bash
80+
make -j5 -C linux/make/debug
81+
```
8182
Alternatively, building can be done directly from the prebuild script with the --build option
83+
```bash
84+
python3 pre_build.py --build
85+
```
8286

83-
$ python3 pre_build.py --build
87+
[qt-online]: https://www.qt.io/blog/qt-5.15.2-released
88+
[qt-offline]: https://download.qt.io/archive/qt/5.12/5.12.6/

0 commit comments

Comments
 (0)