diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 15 insertions, 5 deletions
@@ -6,11 +6,21 @@ C++ System Development Kit for Nostr ### Prerequisites -- CMake 3.14 or later +This project uses CMake as its build system, and vcpkg as its dependency manager. Thus, to build the SDK, you will need the following: + +- CMake 3.19 or later - C++17 compiler -- OpenSSL 1.1.1 or later -- Boost 1.85 or later +- vcpkg + +### Build Targets + +The SDK aims to support Linux, Windows, and macOS build targets. CMake presets are provided for each target. + +#### Linux -### Standalone Build +To build the SDK on Linux, run the following commands from the project root: -When building this library as a standalone project, the `Boost_INCLUDE_DIR` and `OPENSSL_ROOT_DIR` variables must be set at the CMake configuration step. +```bash +cmake --preset=linux . +cmake --build ./build/linux +``` |