-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathBUILD.txt
97 lines (72 loc) · 4.55 KB
/
BUILD.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
Note: These build instructions are outdated.
Look at the Little Navmap Github Wiki for constantly updated instructions:
https://github.com/albar965/littlenavmap/wiki/Compiling
==============================================================================
# Build Instructions
The atools static library is required. Clone atools (`git clone https://github.com/albar965/atools.git`)
and follow the build instructions there. The instructions in this `BUILD.txt` file assume that atools was installed
and compiled successfully and Qt Creator was configured accordingly.
Clone the littlenavconnect GIT repository into the same directory as atools. You can use another
directory but then you need to adapt the configuration by changing environment variables.
Look at the `littlenavconnect.pro` file. There is a list of documented environment variables that
can be set to customize the build, like the inclusion of SimConnect or paths to the projects. Most
of these variables are optional and use a reasonable default value. Set these variables in the Qt
Creator GUI or on the command line.
There is no need to edit the `*.pro` files.
## Default paths and Environment Variables
The projects can be built with almost no configuration changes since all project files fall back to sensible
default paths if the corresponding environment variables are not set. `APROJECTS` is the placeholder for the base directory in
the examples below. Avoid paths with spaces if possible.
* `APROJECTS/atools/src` Sources. `ATOOLS_INC_PATH`
* `APROJECTS/build-atools-debug` atools debug build. `ATOOLS_LIB_PATH`
* `APROJECTS/build-atools-release` atools release build. `ATOOLS_LIB_PATH`
* `APROJECTS/build-littlenavconnect-debug` Little Navconnect debug build.
* `APROJECTS/build-littlenavconnect-release` Little Navconnect release build.
* `APROJECTS/deploy` Target for `make deploy`. `DEPLOY_BASE`
* `APROJECTS/littlenavconnect` Sources.
* `C:\Program Files (x86)\...\SimConnect SDK` SimConnect on Windows only. Optional. `ATOOLS_SIMCONNECT_PATH`
## Windows
- Get OpenSSL binaries from https://wiki.openssl.org/index.php/Binaries/ and extract them
to the project directory.
You might use any 1.1.1 version but have to adapt the OPENSSL_PATH if it differs.
- Install SimConnect if needed (optional). The FSX SP2 is the preferred version.
- Clone littlenavconnect from GIT (`git clone https://github.com/albar965/littlenavconnect.git`)
to e.g.: `C:\Projects\littlenavconnect`
- For littlenavconnect use the build directory of e.g.: `C:\Projects\build-littlenavconnect-release`. Otherwise
change the paths with envronment variables (see `littlenavconnect.pro` file).
- Import littlenavconnect into the Qt Creator workspace (atools should be already there).
- Configure the project and enable the shadow build for release or debug versions.
- Set the environment variables `ATOOLS_SIMCONNECT_PATH` (optional if SimConnect needed) and/or
`OPENSSL_PATH` (required on Windows) in the Qt Creator GUI.
- Set the build kit for atools and littlenavconnect to MinGW 32bit.
- Run qmake from Qt Creator for all projects
- Build all projects from Qt Creator
- Create and run the target `deploy`. This will create a directory `DEPLOY_BASE\Little Navconnect` with the program.
The littlenavconnect project can be built using the MinGW environment only. MSVC will not work.
## Linux / macOS
Install Qt development packages. Version at least 5.6.
You can build the program on Linux or macOS similar to the Windows instructions above either using
the Qt Creator GUI or the command line.
SimConnect is not available on these platforms.
OpenSSL will be detected automatically by the build scripts.
The following assumes that atools was already installed and built.
### To build the littlenavconnect release version:
```
mkdir build-littlenavconnect-release
cd build-littlenavconnect-release
qmake ../littlenavconnect/littlenavconnect.pro CONFIG+=release
make
```
### To build the littlenavconnect debug version:
```
mkdir build-littlenavconnect-debug
cd build-littlenavconnect-debug
qmake ../littlenavconnect/littlenavconnect.pro CONFIG+=debug
make
```
## Branches / Project Dependencies
Make sure to use the correct branches to avoid breaking dependencies.
The branch master is the unstable development branch but all software should compile there.
For releases check the release/MAJOR.MINOR branches to get the correct dependencies.
The atools branch is one MAJOR number ahead.
So Little Navconnect branch `release/1.2` should work well with atools `release/2.2` for example.