aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b38e83fff918f5b10bd0d4ad3bf4c085da691d99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# NostrSDK

C++ System Development Kit for Nostr

## Building the SDK

### Prerequisites

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
- vcpkg

### Build Targets

The SDK aims to support Linux, Windows, and macOS build targets.  CMake presets are provided for each target.

#### Linux

To build the SDK on Linux, run the following commands from the project root:

```bash
cmake --preset=linux .
cmake --build ./build/linux
```