diff options
author | Michael Jurkoic <mjjurkoic@gmail.com> | 2024-04-28 09:56:06 -0500 |
---|---|---|
committer | Michael Jurkoic <mjjurkoic@gmail.com> | 2024-04-28 09:56:06 -0500 |
commit | 047a45bd2e3bda3456c1365115d67847d43dd9f1 (patch) | |
tree | 0a9e004fc5f9c09710d84a5f178eb2a0a137797a /README.md | |
parent | 21aff33f4f194148f768cce28a7ef9c827af29e9 (diff) |
Configure for Linux builds
- Use vcpkg for most dependency management.
- Manually include uuid_v4.
- Update README with prerequisites and build instructions.
- Support subproject and standalone builds.
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 +``` |