INSTALL: Building Plugins generic README.
| This is a copy of the file INSTALL.md, distributed with all plugins. INSTALL.md is the preferred version. |
Install build dependencies as described in the build dependencies page. Then clone this repository, setup the library submodule and enter a fresh working directory:
$ git submodule update --init opencpn-libs $ rm -rf build; mkdir build; cd build
A "normal" (not flatpak) tar.gz tarball which can be used by the new plugin installer available from OpenCPN 5.2.0 is built using:
$ cmake .. $ make tarball
To build the flatpak tarball:
$ cmake .. $ make flatpak
Historically, it has been possible to build legacy packages like an NSIS installer on Windows and .deb packages on Linux. This ability has been removed in the 5.6.0 cycle.
Building for Android
Builds for Android requires an ndk installation and an updated cmake, see the Build Dependencies page
To build an android aarch64 tarball:
$ cmake -DCMAKE_TOOLCHAIN_FILE=cmake/android-aarch64-toolchain.cmake .. $ make
To build an android armhf tarball
$ cmake -DCMAKE_TOOLCHAIN_FILE=cmake/android-armhf-toolchain.cmake .. $ make
Building on windows (MSVC)
On Windows, build is performed in the build directory using a CMD shell.
The first, initial step to install build depencies needs administrative privileges and is run using:
> set PATH=C:\ProgramData\chocolatey\bin;C:\Windows\system32;C:\Windows > ..\buildwin\win_deps.bat
The initial set PATH=… line strips down %PATH% to a very small path,
excluding most if not all otherwise available tools. In many cases this is
neither required nor convenient and can be excluded. However, doing it
represents a tested baseline.
Actual builds can (i. e., should) be performed without administrative privileges by running
> ..\ci\appveyor.bat