Skip to content

Latest commit

 

History

History
106 lines (88 loc) · 4.91 KB

README.md

File metadata and controls

106 lines (88 loc) · 4.91 KB
Raw

libnick

Logo

A cross-platform base for native Nickvision applications.

libnick provides Nickvision apps with a common set of cross-platform APIs for managing system and desktop app functionality such as network management, taskbar icons, translations, app updates, and more.

Documentation

Documentation for this library and its modules can be found here.

Dependencies

The following are a list of dependencies used by libnick.

All Platforms

  • boost-json
  • gtest
  • libcurl
  • libintl
  • maddy

Windows

The above dependencies must be installed, plus the following for Windows systems:

  • sqlcipher

Linux

The above dependencies must be installed, plus the following for Linux systems:

  • glib
  • libsecret
  • openssl
    • Used for sqlcipher, as libnick manually builds sqlcipher on Linux as the vcpkg port is broken.

macOS

The above dependencies must be installed, plus the following for macOS systems:

  • glib
  • libsecret (Only required if -DUSE_LIBSECRET="ON")
  • openssl
    • Used for sqlcipher, as libnick manually builds sqlcipher on macOS as the vcpkg port is broken.

Consuming libnick via vcpkg

libnick is available through vcpkg.

Simply install and configure vcpkg for your system, and run:

vcpkg install libnick

You can then use libnick from cmake with the following:

find_package(libnick CONFIG REQUIRED)
target_link_libraries(main PRIVATE libnick::libnick)

Building and Installing Manually

libnick uses vcpkg to manage its dependencies and cmake as its build system.

Ensure both vcpkg and cmake are installed on your system before building and installing libnick.

A C++20 compiler is also required to build libnick.

Configuring vcpkg

  1. Set the VCPKG_ROOT environment variable to the path of your vcpkg installation's root directory.

Windows

  1. Set the VCPKG_DEFAULT_TRIPLET environment variable to x64-windows
  2. Run vcpkg install boost-json curl gettext-libintl gtest maddy sqlcipher

Linux

  1. Set the VCPKG_DEFAULT_TRIPLET environment variable to x64-linux
  2. Run vcpkg install boost-json curl gettext-libintl glib gtest libsecret maddy openssl

macOS (Intel)

  1. Set the VCPKG_DEFAULT_TRIPLET environment variable to x64-osx
  2. Run vcpkg install boost-json curl gettext-libintl glib gtest libsecret maddy openssl

macOS (Apple Silicon)

  1. Set the VCPKG_DEFAULT_TRIPLET environment variable to arm64-osx
  2. Run vcpkg install boost-json curl gettext-libintl glib gtest libsecret maddy openssl

Building

  1. First, clone/download the repo.
  2. Open a terminal and navigate to the repo's root directory.
  3. Create a new build directory and cd into it.

Windows

  1. From the build folder, run cmake .. -G "Visual Studio 17 2022".
    • To skip building libnick's test suite, add -DBUILD_TESTING="OFF" to the end of the command.
    • If you plan to install libnick, add -DCMAKE_INSTALL_PREFIX=PATH_TO_INSTALL_DIR to the end of the command, replacing PATH_TO_INSTALL_DIR with the path of where you'd like libnick to install to.
  2. From the build folder, run cmake --build . --config Release.
  3. After these commands complete, libnick will be successfully built and its binaries can be found in the Release folder of the build folder.

Linux

  1. From the build folder, run cmake .. -DCMAKE_BUILD_TYPE=Release.
    • To skip building libnick's test suite, add -DBUILD_TESTING="OFF" to the end of the command.
    • If you plan to install libnick, add -DCMAKE_INSTALL_PREFIX=PATH_TO_INSTALL_DIR to the end of the command, replacing PATH_TO_INSTALL_DIR with the path of where you'd like libnick to install to.
  2. From the build folder, run cmake --build ..
  3. After these commands complete, libnick will be successfully built and its binaries can be found in the build folder.

macOS

  1. From the build folder, run cmake .. -DCMAKE_BUILD_TYPE=Release.
    • To skip building libnick's test suite, add -DBUILD_TESTING="OFF" to the end of the command.
    • To use libsecret instead of macOS's built in security library, add -DUSE_LIBSECRET="ON" to the end of the command.
    • If you plan to install libnick, add -DCMAKE_INSTALL_PREFIX=PATH_TO_INSTALL_DIR to the end of the command, replacing PATH_TO_INSTALL_DIR with the path of where you'd like libnick to install to.
  2. From the build folder, run cmake --build ..
  3. After these commands complete, libnick will be successfully built and its binaries can be found in the build folder.

Installing

  1. To install libnick to the system, from the build folder, run cmake --install ..
    • This command will export and install libnick cmake targets allowing you to simply use libnick in other cmake projects with the following: 
      find_package(libnick CONFIG REQUIRED)
target_link_libraries(main PRIVATE libnick::libnick)