Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nlogozzo committed Jun 12, 2024
1 parent 06a8f80 commit d06540f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit d06540f

Please sign in to comment.