From d06540ff78fbd21a387f394e4b6093f4cae4d42b Mon Sep 17 00:00:00 2001 From: Nick Logozzo Date: Wed, 12 Jun 2024 10:25:23 -0400 Subject: [PATCH] Update docs --- CHANGELOG.md | 8 ++++++++ README.md | 11 +++++++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 728b00c..3949af2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 2024.6.6 (next) +### Breaking Changes +None +### New APIs +- Added support for `macOS` across the library +### Fixes +None + ## 2024.6.5 ### Breaking Changes None diff --git a/README.md b/README.md index dc29461..27eebbb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ **A cross-platform base for native Nickvision applications.** -libnick provides Nickvision apps with a common set of cross-platform (Windows and Linux) APIs for managing system and desktop app functionality such as network management, taskbar icons, translations, app updates, and more. +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 @@ -24,8 +24,8 @@ The following are a list of dependencies used by libnick. The above dependencies must be installed, plus the following for Windows systems: - sqlcipher -### Linux Only -The above dependencies must be installed, plus the following for Linux systems: +### Linux/macOS Only +The above dependencies must be installed, plus the following for Linux/macOS systems: - glib - libsecret - libuuid @@ -60,6 +60,9 @@ A C++20 compiler is also required to build libnick. #### Linux 1. Set the `VCPKG_DEFAULT_TRIPLET` environment variable to `x64-linux` 1. Run `vcpkg install curl gettext-libintl glib gtest jsoncpp libsecret libuuid maddy openssl` +#### macOS +1. Set the `VCPKG_DEFAULT_TRIPLET` environment variable to `x64-osx` +1. Run `vcpkg install curl gettext-libintl glib gtest jsoncpp libsecret libuuid maddy openssl` ### Building 1. First, clone/download the repo. @@ -71,7 +74,7 @@ A C++20 compiler is also required to build libnick. - 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. 1. From the `build` folder, run `cmake --build . --config Release`. 1. After these commands complete, libnick will be successfully built and its binaries can be found in the `Release` folder of the `build` folder. -#### Linux +#### Linux/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. - 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.