Skip to content

Commit 1b4df5a

Browse files
authored
Update README.md
1 parent f3bf731 commit 1b4df5a

File tree

1 file changed

+96
-1
lines changed

1 file changed

+96
-1
lines changed

README.md

+96-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,102 @@ As the name suspects, it is based on QT (5.15.X).
1717
We have a CI setup that checks compilation on ubuntu. You can look at the steps it performs to build and run QOpenHD.
1818
Other platforms than Linux are not supported right now.
1919

20-
# Manual Building / MAVSDK
20+
# Building QOpenHD Locally in QT (GSTREAMER MIGHT NOT BE REQUIRED as things progress)
21+
#### Mac
22+
23+
1. Install Xcode from the Mac App Store.
24+
25+
2. Install Qt using the [Qt online installer](https://www.qt.io/download-qt-installer)
26+
27+
3. Have the Qt Installer download Qt 5.15.0+ for Mac, and Qt Creator
28+
29+
4. Clone the source code:
30+
31+
git clone --recurse-submodules https://github.com/OpenHD/QOpenHD.git
32+
33+
If you aren't using git from the command line but using a GUI git client instead, make sure
34+
you update the submodules or QOpenHD will not build properly.
35+
36+
37+
Once you have those steps done you can open `QOpenHD.pro` with Qt Creator, build and run it.
38+
39+
#### iOS
40+
41+
1. Install Xcode from the Mac App Store.
42+
43+
2. Install Qt using the [Qt online installer](https://www.qt.io/download-qt-installer)
44+
45+
3. Have the Qt Installer download Qt 5.15.0+ for iOS, and Qt Creator
46+
47+
4. You will need an Apple developer membership to install directly to an iOS device
48+
49+
5. Clone the source code:
50+
51+
git clone --recurse-submodules https://github.com/OpenHD/QOpenHD.git
52+
53+
If you aren't using git from the command line but using a GUI git client instead, make sure
54+
you update the submodules or QOpenHD will not build properly.
55+
56+
Once you have those steps done you can open `QOpenHD.pro` with Qt Creator, build and run it.
57+
58+
#### Windows
59+
60+
1. Install Visual Studio 2019 (free)
61+
62+
2. Install Qt using the [Qt online installer](https://www.qt.io/download-qt-installer)
63+
64+
3. Have the Qt Installer download Qt 5.15.0+ and Qt Creator
65+
66+
4. Download the [GStreamer development kit](https://gstreamer.freedesktop.org/download/) for Windows, both the Runtime and Development packages. You *must use* the 32-bit MinGW packages, NOT the one labeled MSVC, and it should be version 1.14.4. (QT will look for gstreamer in c:/gstreamer/1.0/x86 )
67+
68+
5. Clone the source code:
69+
70+
git clone --recurse-submodules https://github.com/OpenHD/QOpenHD.git
71+
72+
If you aren't using git from the command line but using a GUI git client instead, make sure
73+
you update the submodules or QOpenHD will not build properly.
74+
75+
Once you have those steps done you can open `QOpenHD.pro` with Qt Creator, build and run it.
76+
77+
#### Linux
78+
79+
1. Install Qt using the [Qt online installer](https://www.qt.io/download-qt-installer)
80+
81+
2. Have it download Qt 5.15.0+ for Linux
82+
83+
3. Install GStreamer development packages from the package manager. On Ubuntu this would be `apt install gstreamer1.0-gl libgstreamer1.0-dev libgstreamer-plugins-good1.0-dev gstreamer1.0-plugins-good libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-base libgstreamer-plugins-bad1.0-dev gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-qt`. Those should pull in any others that are needed as well.
84+
85+
4. Clone the source code:
86+
87+
git clone --recurse-submodules https://github.com/OpenHD/QOpenHD.git
88+
89+
If you aren't using git from the command line but using a GUI git client instead, make sure
90+
you update the submodules or QOpenHD will not build properly.
91+
92+
Once you have those steps done you can open `QOpenHD.pro` with Qt Creator, build and run it.
93+
94+
#### Android
95+
96+
1. Install [Android Studio](https://developer.android.com/studio)
97+
98+
2. Use Android Studio to install Android SDK level 28, along with NDK r18b and the associated build toolchain.
99+
100+
3. Install Qt using the [Qt online installer](https://www.qt.io/download-qt-installer)
101+
102+
4. Have the Qt Installer download Qt 5.15.0+ *for Android*, not for the OS you're building on.
103+
104+
5. Clone the source code:
105+
106+
git clone --recurse-submodules https://github.com/OpenHD/QOpenHD.git
107+
108+
If you aren't using git from the command line but using a GUI git client instead, make sure
109+
you update the submodules or QOpenHD will not build properly.
110+
111+
You can then open `QOpenHD.pro` using Qt Creator and set up the Android kit (left side, click the Projects tab), build and run the app on your device.
112+
113+
114+
115+
# Building MAVSDK (REQUIRED)
21116
QOpenHD relies on MAVSDK library. After recursively cloning qopenhd build this library:
22117

23118
`cd lib/MAVSDK`

0 commit comments

Comments
 (0)