windows_installation.rst

Build and Install on Windows

This guide describes the process of building and installing EasyNMEA on Windows platforms:

• Prerequisites
• Dependencies
• Build
• Install

Prerequisites

To build and install EasyNMEA, some external tools are required.

• CMake
• Visual Studio
• Wget
• Git
• Chocolatey
• pip3

Dependencies

EasyNMEA depends on Asio, a cross-platform C++ library for network and low-level I/O programming that provides a consistent asynchronous model, which is used to interact with the serial ports. Chocolatey can be used to install Asio on Windows platforms. Download the package and run:

choco install -y -s <download_dir> asio

Where <download_dir> is the directory into which the package has been downloaded.

Build

Once the :ref:`prerequisites<installation_windows_prerequisites>` and :ref:`dependencies<installation_windows_dependencies>` are installed, EasyNMEA can be built with CMake by running:

cd ~
git clone https://github.com/EduPonz/easynmea.git
cd easynmea
mkdir build && cd build
cmake ..
cmake --build .

Note

For more information about compilation options please refer to :ref:`installation_cmake_options`.

Install

Once the library is built, in can be installed in a user specified directory with:

cd ~/easynmea/build
cmake .. -DCMAKE_INSTALL_PREFIX=<user-specified-dir>
cmake --build . --target install

Alternatively, it can also be installed system-wide with:

cd ~/easynmea/build
cmake ..
cmake --build . --target install