Skip to content

Commit 35396cd

Browse files
committed
Add build instructions for Linux.
1 parent 20ddaa5 commit 35396cd

26 files changed

+459
-394
lines changed
-9.48 KB
Binary file not shown.
-8.09 KB
Binary file not shown.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# How to Build (Qt 6.8.2) - Ubuntu 24.04
2+
3+
Note that our Ubuntu setup does not work. The video display flickers to the point of being unusable.
4+
5+
## Build Tools:
6+
7+
Install the following packages:
8+
9+
```
10+
sudo apt install cmake
11+
sudo apt install libglx-dev libgl1-mesa-dev
12+
sudo apt install libopencv-dev
13+
```
14+
15+
16+
## Install Qt 6.8.2:
17+
18+
Unlike with Qt 5.12, there is no offline installer for it. So you have two options here, use the online installer, or use a copy of an installation.
19+
20+
### Official Online Installer:
21+
22+
If you are ok with creating an account with Qt and using their online installer, then use this method.
23+
24+
1. Download the online installer from here: https://www.qt.io/download-qt-installer
25+
2. Select custom install settings.
26+
3. Select the following options:
27+
- Qt 6.8.2
28+
- MSVC 2022 64-bit
29+
- Sources
30+
- Additional Libraries
31+
- Qt Image Formats
32+
- Qt Multimedia
33+
- Qt Serial Port
34+
- Qt Debug Information Files
35+
36+
![](Images/Windows-Install-Qt6.7.3-Custom.png)
37+
![](Images/Windows-Install-Qt6.8.2-Components.png)
38+
39+
## Setup:
40+
41+
1. Clone this repo.
42+
2. Clone the [Packages Repo](https://github.com/PokemonAutomation/Packages).
43+
3. In the `Packages` repo, copy the `SerialPrograms/Resources` folder into the root of the `Arduino-Source` repo.
44+
45+
![](Images/Directory.png)
46+
47+
4. Open Qt Creator.
48+
5. Click on `File` -> `Open File or Project`.
49+
6. Navigate to `SerialPrograms` and select `CMakeLists.txt`.
50+
7. (configuration details TDB)
51+
8. At the bottom left corner, click on the little monitor and select `Release with Debug Information`.
52+
9. Still in the bottom left corner, click the upper green arrow to compile and launch the program.
53+
54+
<hr>
55+
56+
**Discord Server:**
57+
58+
59+
[<img src="https://canary.discordapp.com/api/guilds/695809740428673034/widget.png?style=banner2">](https://discord.gg/cQ4gWxN)
60+

SerialPrograms/Build-Qt5.12.md renamed to SerialPrograms/BuildInstructions/Build-Windows-Qt5.12.md

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,60 @@
1-
# How to Build (Qt 5.12) - Windows
2-
3-
## Build Tools:
4-
5-
1. Install Visual Studio 2019:
6-
1. [Download Page](https://docs.microsoft.com/en-us/visualstudio/releases/2019/release-notes)
7-
2. Make sure you select the C++ development tools.
8-
2. Install Windows Development SDK:
9-
1. [Download Page](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/)
10-
3. Install CMake:
11-
1. [Download Page](https://cmake.org/download/)
12-
2. When prompted select, "Add CMake to the system PATH for all users".
13-
4. Install Qt 5.12.12:
14-
1. [Download the offline installer.](https://www.qt.io/offline-installers) [Direct Download Link](https://download.qt.io/official_releases/qt/5.12/5.12.12/qt-opensource-windows-x86-5.12.12.exe)
15-
2. Disconnect from the internet. This is needed to keep it from forcing you to create an account.
16-
3. Run the installer.
17-
4. When prompted for components, select all of the following:
18-
- Qt 5.12.12
19-
- MSVC 2017 32-bit
20-
- MSVC 2017 64-bit
21-
- MinGW 7.3.0 32-bit
22-
- MinGW 7.3.0 64-bit
23-
- Developer and Designer Tools
24-
- Qt Creator 5.0.2 CDB Debugger Support
25-
- MinGW 7.3.0 32-bit
26-
- MinGW 7.3.0 64-bit
27-
28-
![](../BuildSetup/Windows-Install-Qt.png)
29-
30-
## Setup:
31-
32-
1. Clone this repo.
33-
2. Clone the [Packages Repo](https://github.com/PokemonAutomation/Packages).
34-
3. In the `Packages` repo, copy the `SerialPrograms/Resources` folder into the root of the `Arduino-Source` repo.
35-
36-
![](../BuildSetup/Directory.png)
37-
38-
4. Open Qt Creator.
39-
5. Click on `Projects` -> `Open`.
40-
6. Navigate to [`SerialPrograms`](./) and select `CMakeLists.txt`.
41-
7. It will then ask you to configure the project. Select `Desktop Qt 5.12.12 MSVC2017 64bit`*.
42-
8. At the bottom left corner, click on the little monitor and select `Release with Debug Information`.
43-
9. Open up the file `CMakeLists.txt`. Change `QT_MAJOR` to `5`.![](../BuildSetup/QT_MAJOR-6.png)
44-
10. Click the upper green arrow** to compile and launch the program.
45-
46-
![](../BuildSetup/Windows-Configuration.png)
47-
48-
49-
*Even though it says "MSVC2017", it will be using your MSVC 2019 installation instead.
50-
51-
**Note that you will not be able to feasibly run with a debugger attached. This is because Qt Creator places a breakpoint on every single thrown exception and this application heavily uses exceptions even for non-error situations. So the debugger will break on literally everything. If you know how to disable break on exceptions, please let us know.
52-
53-
54-
<hr>
55-
56-
**Discord Server:**
57-
58-
59-
[<img src="https://canary.discordapp.com/api/guilds/695809740428673034/widget.png?style=banner2">](https://discord.gg/cQ4gWxN)
60-
1+
# How to Build (Qt 5.12) - Windows
2+
3+
## Build Tools:
4+
5+
1. Install Visual Studio 2019:
6+
1. [Download Page](https://docs.microsoft.com/en-us/visualstudio/releases/2019/release-notes)
7+
2. Make sure you select the C++ development tools.
8+
2. Install Windows Development SDK:
9+
1. [Download Page](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/)
10+
3. Install CMake:
11+
1. [Download Page](https://cmake.org/download/)
12+
2. When prompted select, "Add CMake to the system PATH for all users".
13+
4. Install Qt 5.12.12:
14+
1. [Download the offline installer.](https://www.qt.io/offline-installers) [Direct Download Link](https://download.qt.io/official_releases/qt/5.12/5.12.12/qt-opensource-windows-x86-5.12.12.exe)
15+
2. Disconnect from the internet. This is needed to keep it from forcing you to create an account.
16+
3. Run the installer.
17+
4. When prompted for components, select all of the following:
18+
- Qt 5.12.12
19+
- MSVC 2017 32-bit
20+
- MSVC 2017 64-bit
21+
- MinGW 7.3.0 32-bit
22+
- MinGW 7.3.0 64-bit
23+
- Developer and Designer Tools
24+
- Qt Creator 5.0.2 CDB Debugger Support
25+
- MinGW 7.3.0 32-bit
26+
- MinGW 7.3.0 64-bit
27+
28+
![](Images/Windows-Install-Qt.png)
29+
30+
## Setup:
31+
32+
1. Clone this repo.
33+
2. Clone the [Packages Repo](https://github.com/PokemonAutomation/Packages).
34+
3. In the `Packages` repo, copy the `SerialPrograms/Resources` folder into the root of the `Arduino-Source` repo.
35+
36+
![](Images/Directory.png)
37+
38+
4. Open Qt Creator.
39+
5. Click on `Projects` -> `Open`.
40+
6. Navigate to [`SerialPrograms`](./) and select `CMakeLists.txt`.
41+
7. It will then ask you to configure the project. Select `Desktop Qt 5.12.12 MSVC2017 64bit`*.
42+
8. At the bottom left corner, click on the little monitor and select `Release with Debug Information`.
43+
9. Open up the file `CMakeLists.txt`. Change `QT_MAJOR` to `5`.![](Images/QT_MAJOR-6.png)
44+
10. Click the upper green arrow** to compile and launch the program.
45+
46+
![](Images/Windows-Configuration.png)
47+
48+
49+
*Even though it says "MSVC2017", it will be using your MSVC 2019 installation instead.
50+
51+
**Note that you will not be able to feasibly run with a debugger attached. This is because Qt Creator places a breakpoint on every single thrown exception and this application heavily uses exceptions even for non-error situations. So the debugger will break on literally everything. If you know how to disable break on exceptions, please let us know.
52+
53+
54+
<hr>
55+
56+
**Discord Server:**
57+
58+
59+
[<img src="https://canary.discordapp.com/api/guilds/695809740428673034/widget.png?style=banner2">](https://discord.gg/cQ4gWxN)
60+

SerialPrograms/Build-Qt6.3.2.md renamed to SerialPrograms/BuildInstructions/Build-Windows-Qt6.3.2.md

Lines changed: 81 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,81 @@
1-
# How to Build (Qt 6.3.2) - Windows
2-
3-
We recommend that you install everything here in the exact order listed and the exact versions mentioned. Failing either will likely result in a broken Qt Creator installation that must be fixed by manually configuring it (which is not fun if you don't know what you're doing).
4-
5-
Required Versions:
6-
- **Visual Studio 2019** - You must install VS2019. If you install VS2022 instead, your Qt Creator installation will be broken. It is ok to have both VS2019 and VS2022 installed. But you must have VS2019 as that is the version that Qt Creator will look for.
7-
- **Qt 6.3.2** - Do not install a later version of Qt. All Qt versions 6.4.x - 6.5.2 are broken for this project.
8-
9-
## Build Tools:
10-
11-
The installation order here is important. While other orderings may work, this is the specific order that we have tested. And the Qt installation must be the last thing installed.
12-
13-
1. Install Visual Studio 2019:
14-
1. [Download Page](https://docs.microsoft.com/en-us/visualstudio/releases/2019/release-notes)
15-
2. Make sure you select the C++ development tools.
16-
2. Install Windows Development SDK:
17-
1. [Download Page](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/)
18-
3. Install CMake:
19-
1. [Download Page](https://cmake.org/download/)
20-
2. When prompted select, "Add CMake to the system PATH for all users".
21-
22-
## Install Qt 6.3.2:
23-
24-
Unlike with Qt 5.12, there is no offline installer for it. So you have two options here, use the online installer, or use a copy of an installation.
25-
26-
### Official Online Installer:
27-
28-
If you are ok with creating an account with Qt and using their online installer, then use this method.
29-
30-
1. Download the online installer from here: https://www.qt.io/download-qt-installer
31-
2. When prompted to select components, check `Archive` on the right side bar, then click `Filter`. Then select the following options:
32-
33-
- Qt 6.3.2
34-
- MSVC 2019 64-bit
35-
- Sources
36-
- Additional Libraries
37-
- Qt Image Formats
38-
- Qt Multimedia
39-
- Qt Serial Port
40-
- Qt Debug Information Files
41-
42-
![](../BuildSetup/Windows-Install-Qt6.3.1.png)
43-
44-
If you repeatedly run into an error involving "SSL handshake failed", you will not be able to use the online installer. Please try the other option.
45-
46-
### Unofficial Installation Copy:
47-
48-
If you are unable or unwilling to use the online installer, the alternative is to copy an installation directly into your system. To do this, you will need to download the installation from us, and copy it into your C drive.
49-
50-
1. Join our [Discord server](https://discord.gg/cQ4gWxN) and ask for the link to the Qt6 standalone. Someone will DM you with a link*.
51-
2. Download `Qt6.3.2.7z` and decompress it. You can use [7-zip](https://www.7-zip.org/) to decompress it. This will create a folder with the same name.
52-
3. Move this folder to `C:\`. It will probably ask you for permissions to do it.
53-
4. Navigate to: `C:\Qt6.3.2\Tools\QtCreator\bin\` and create a shortcut to `qtcreator.exe`. Copy this shortcut to somewhere convenient. (By default this shortcut is named, `Qt Creator 8.0.1 (Community)`)
54-
55-
*This Qt6 standalone file is 3GB in size and is being hosted by our staff for our own developers. We don't want the entire world converging here and overrunning the server.
56-
57-
## Setup:
58-
59-
1. Clone this repo.
60-
2. Clone the [Packages Repo](https://github.com/PokemonAutomation/Packages).
61-
3. In the `Packages` repo, copy the `SerialPrograms/Resources` folder into the root of the `Arduino-Source` repo.
62-
63-
![](../BuildSetup/Directory.png)
64-
65-
4. Open Qt Creator.
66-
5. Click on `File` -> `Open File or Project`.
67-
6. Navigate to [`SerialPrograms`](./) and select `CMakeLists.txt`.
68-
7. It will then ask you to configure the project. Select `Desktop Qt 6.3.2 MSVC2019 64bit`. Click `Configure Project`.
69-
![](../BuildSetup/Windows-configure-project.png)
70-
8. At the bottom left corner, click on the little monitor and select `Release with Debug Information`.
71-
![](../BuildSetup/Windows-Configuration-Qt6.png)
72-
9. At the bottom left corner, click the upper green arrow to compile and launch the program.
73-
74-
75-
<hr>
76-
77-
**Discord Server:**
78-
79-
80-
[<img src="https://canary.discordapp.com/api/guilds/695809740428673034/widget.png?style=banner2">](https://discord.gg/cQ4gWxN)
81-
1+
# How to Build (Qt 6.3.2) - Windows
2+
3+
We recommend that you install everything here in the exact order listed and the exact versions mentioned. Failing either will likely result in a broken Qt Creator installation that must be fixed by manually configuring it (which is not fun if you don't know what you're doing).
4+
5+
Required Versions:
6+
- **Visual Studio 2019** - You must install VS2019. If you install VS2022 instead, your Qt Creator installation will be broken. It is ok to have both VS2019 and VS2022 installed. But you must have VS2019 as that is the version that Qt Creator will look for.
7+
- **Qt 6.3.2** - Do not install a later version of Qt. All Qt versions 6.4.x - 6.5.2 are broken for this project.
8+
9+
## Build Tools:
10+
11+
The installation order here is important. While other orderings may work, this is the specific order that we have tested. And the Qt installation must be the last thing installed.
12+
13+
1. Install Visual Studio 2019:
14+
1. [Download Page](https://docs.microsoft.com/en-us/visualstudio/releases/2019/release-notes)
15+
2. Make sure you select the C++ development tools.
16+
2. Install Windows Development SDK:
17+
1. [Download Page](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/)
18+
3. Install CMake:
19+
1. [Download Page](https://cmake.org/download/)
20+
2. When prompted select, "Add CMake to the system PATH for all users".
21+
22+
## Install Qt 6.3.2:
23+
24+
Unlike with Qt 5.12, there is no offline installer for it. So you have two options here, use the online installer, or use a copy of an installation.
25+
26+
### Official Online Installer:
27+
28+
If you are ok with creating an account with Qt and using their online installer, then use this method.
29+
30+
1. Download the online installer from here: https://www.qt.io/download-qt-installer
31+
2. When prompted to select components, check `Archive` on the right side bar, then click `Filter`. Then select the following options:
32+
33+
- Qt 6.3.2
34+
- MSVC 2019 64-bit
35+
- Sources
36+
- Additional Libraries
37+
- Qt Image Formats
38+
- Qt Multimedia
39+
- Qt Serial Port
40+
- Qt Debug Information Files
41+
42+
![](Images/Windows-Install-Qt6.3.1.png)
43+
44+
If you repeatedly run into an error involving "SSL handshake failed", you will not be able to use the online installer. Please try the other option.
45+
46+
### Unofficial Installation Copy:
47+
48+
If you are unable or unwilling to use the online installer, the alternative is to copy an installation directly into your system. To do this, you will need to download the installation from us, and copy it into your C drive.
49+
50+
1. Join our [Discord server](https://discord.gg/cQ4gWxN) and ask for the link to the Qt6 standalone. Someone will DM you with a link*.
51+
2. Download `Qt6.3.2.7z` and decompress it. You can use [7-zip](https://www.7-zip.org/) to decompress it. This will create a folder with the same name.
52+
3. Move this folder to `C:\`. It will probably ask you for permissions to do it.
53+
4. Navigate to: `C:\Qt6.3.2\Tools\QtCreator\bin\` and create a shortcut to `qtcreator.exe`. Copy this shortcut to somewhere convenient. (By default this shortcut is named, `Qt Creator 8.0.1 (Community)`)
54+
55+
*This Qt6 standalone file is 3GB in size and is being hosted by our staff for our own developers. We don't want the entire world converging here and overrunning the server.
56+
57+
## Setup:
58+
59+
1. Clone this repo.
60+
2. Clone the [Packages Repo](https://github.com/PokemonAutomation/Packages).
61+
3. In the `Packages` repo, copy the `SerialPrograms/Resources` folder into the root of the `Arduino-Source` repo.
62+
63+
![](Images/Directory.png)
64+
65+
4. Open Qt Creator.
66+
5. Click on `File` -> `Open File or Project`.
67+
6. Navigate to [`SerialPrograms`](./) and select `CMakeLists.txt`.
68+
7. It will then ask you to configure the project. Select `Desktop Qt 6.3.2 MSVC2019 64bit`. Click `Configure Project`.
69+
![](Images/Windows-configure-project.png)
70+
8. At the bottom left corner, click on the little monitor and select `Release with Debug Information`.
71+
![](Images/Windows-Configuration-Qt6.png)
72+
9. At the bottom left corner, click the upper green arrow to compile and launch the program.
73+
74+
75+
<hr>
76+
77+
**Discord Server:**
78+
79+
80+
[<img src="https://canary.discordapp.com/api/guilds/695809740428673034/widget.png?style=banner2">](https://discord.gg/cQ4gWxN)
81+

0 commit comments

Comments
 (0)