You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: manual/README.md
+28-39Lines changed: 28 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,44 +6,36 @@
6
6
7
7
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.
8
8
9
-
## 2025.6.3
9
+
## 2025.6.4
10
10
### Breaking Changes
11
11
None
12
12
### New APIs
13
13
None
14
14
### Fixes
15
-
- Fixed an issue with the cmake configuration file
15
+
#### System
16
+
- Fixed an issue where `Process::pause()` and `Process::resume()` did not work correctly on Windows
16
17
17
18
## Dependencies
18
-
The following are a list of dependencies used by libnick.
19
+
The following are a list of dependencies used by libnick.
20
+
21
+
The recommendation and below commands will use vcpkg to pull these dependencies. However, vcpkg is not a requirement as long as the system provides these dependencies correctly.
19
22
20
23
### All Platforms
21
24
- boost-json
22
25
- gtest
23
26
- libcurl
24
27
- libintl
25
28
- maddy
29
+
- sqlcipher (Must be provided by the system on Linux and macOS as sqlcipher is not available via vcpkg for these systems)
26
30
27
-
### Windows
28
-
The above dependencies must be installed, *plus* the following for Windows systems:
29
-
- sqlcipher
30
-
31
-
### Linux
32
-
The above dependencies must be installed, *plus* the following for Linux systems:
31
+
### Linux and macOS
32
+
The above dependencies must be installed, *plus* the following for Linux and macOS systems:
33
33
- glib
34
34
- libsecret
35
-
- openssl
36
-
- Used for sqlcipher, as libnick manually builds sqlcipher on Linux as the vcpkg port is broken.
37
-
38
-
### macOS
39
-
The above dependencies must be installed, *plus* the following for macOS systems:
40
-
- glib
41
-
- libsecret (Only required if `-DUSE_LIBSECRET="ON"`)
42
-
- openssl
43
-
- Used for sqlcipher, as libnick manually builds sqlcipher on macOS as the vcpkg port is broken.
35
+
- For macOS: Only required if `-DUSE_LIBSECRET="ON"`
44
36
45
37
## Consuming libnick via vcpkg
46
-
libnick is available through `vcpkg`.
38
+
libnick is available through `vcpkg`.
47
39
48
40
Simply install and configure vcpkg for your system, and run:
1. Open a terminal and navigate to the repo's root directory.
83
-
1. Create a new `build` directory and `cd` into it.
72
+
1. Create a new `build` directory and `cd` into it.
84
73
#### Windows
85
74
1. From the `build` folder, run `cmake .. -G "Visual Studio 17 2022"`.
86
-
- To skip building libnick's test suite, add `-DBUILD_TESTING="OFF"` to the end of the command.
87
-
- 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.
75
+
- To skip building libnick's test suite, add `-DBUILD_TESTING="OFF"` to the end of the command.
76
+
- 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.
88
77
1. From the `build` folder, run `cmake --build . --config Release`.
89
78
1. After these commands complete, libnick will be successfully built and its binaries can be found in the `Release` folder of the `build` folder.
90
79
#### Linux
91
80
1. From the `build` folder, run `cmake .. -DCMAKE_BUILD_TYPE=Release`.
92
-
- To skip building libnick's test suite, add `-DBUILD_TESTING="OFF"` to the end of the command.
93
-
- 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.
81
+
- To skip building libnick's test suite, add `-DBUILD_TESTING="OFF"` to the end of the command.
82
+
- 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.
94
83
1. From the `build` folder, run `cmake --build .`.
95
84
1. After these commands complete, libnick will be successfully built and its binaries can be found in the `build` folder.
96
85
#### macOS
97
86
1. From the `build` folder, run `cmake .. -DCMAKE_BUILD_TYPE=Release`.
98
-
- To skip building libnick's test suite, add `-DBUILD_TESTING="OFF"` to the end of the command.
99
-
- To use `libsecret` instead of macOS's built in security library, add `-DUSE_LIBSECRET="ON"` to the end of the command.
100
-
- 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.
87
+
- To skip building libnick's test suite, add `-DBUILD_TESTING="OFF"` to the end of the command.
88
+
- To use `libsecret` instead of macOS's built in security library, add `-DUSE_LIBSECRET="ON"` to the end of the command.
89
+
- 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.
101
90
1. From the `build` folder, run `cmake --build .`.
102
91
1. After these commands complete, libnick will be successfully built and its binaries can be found in the `build` folder.
103
92
104
93
### Installing
105
94
1. To install libnick to the system, from the `build` folder, run `cmake --install .`.
106
-
- This command will export and install libnick cmake targets allowing you to simply use libnick in other cmake projects with the following:
0 commit comments