From 80885e4f6b83a3a63b9a74640a13a66cc27d7933 Mon Sep 17 00:00:00 2001 From: buttercat1791 Date: Mon, 6 May 2024 09:04:57 -0500 Subject: Add details to README --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f186fe2..e9189dc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # Aedile -C++ System Development Kit for Nostr +A Nostr System Development Kit written in C++. + +## Behind the Name + +In the ancient Roman Republic, the aediles were officials elected from among the plebians and charged with caring for Rome's public infrastructure and ensuring an accurate system of weights and measures. + +The aim of the Aedile SDK is in the spirit of that ancient office: + +- Provide a fast and efficient service for interacting with Nostr relays via WebSocket connections. +- Offer stable, well-tested implementations of commonly-used [Nostr Implementation Possibilities (NIPs)](https://github.com/nostr-protocol/nips/tree/master). +- Open up Nostr development by taking care of the basics so developers can focus on solving problems, rather than reimplementing the protocol. ## Building the SDK @@ -9,19 +19,20 @@ C++ System Development Kit for Nostr 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 +- A C++17 compiler - vcpkg +CMake invokes vcpkg at the start of the configure process to install some of the project's dependencies. For this step to succeed, ensure that the `VCPKG_ROOT` environment variable is set to the path of your vcpkg installation. + ### Building and Testing -The SDK aims to support Linux, Windows, and macOS build targets. CMake presets are provided for each target. +The SDK aims to support Linux, Windows, and macOS build targets. It currently supplies a CMake preset for Linux. #### Linux To build the SDK on Linux, run the following commands from the project root: ```bash -cmake --preset linux cmake --build --preset linux ``` -- cgit