diff --git a/README.md b/README.md index 59c3c200..37877b55 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,19 @@ Implementation of the proposed [Messaging Layer Security](https://github.com/mls Prerequisites ------------- -MLSPP requires a few prerequisite libraries in order to build. +MLSPP requires a few prerequisite libraries in order to fully build. * [nlohmann::json](https://github.com/nlohmann/json) - Tested with latest versions. -* SSL Implementation - OpenSSL 1.1.1, OpenSSL 3.0, BoringSSL compatible +* Cryptography Library - OpenSSL 1.1.1, OpenSSL 3.0, BoringSSL compatible (see details below) * [doctest](https://github.com/doctest/doctest) - Tested with latest versions. Only required when building the test suite. ### Installing Prerequisites -The following should satisfy the prerequisites for these popular platforms. +The following should satisfy the prerequisites for these popular platforms. However, [vcpkg](https://vcpkg.io/en/) is recommended for developer builds. ``` -# Linux - Ubuntu 20.04 -$ sudo apt install ssl-dev nlohmann-json3-dev doctest-dev +# Linux - Ubuntu 20.04, Ubuntu 22.04 +$ sudo apt install libssl-dev nlohmann-json3-dev doctest-dev # MacOs - Homebrew $ brew install nlohmann-json doctest @@ -29,12 +29,12 @@ $ brew install nlohmann-json doctest Quickstart ---------- -A convenience Makefile is included to avoid the need to remember a bunch of -CMake parameters. +A convenience Makefile is included to avoid the need to remember a bunch of CMake parameters. It will use [vcpkg](https://vcpkg.io/en/) to satisfy all dependencies. ``` > make # Configures and builds the library -> make dev # Configure a "developer" build with tests and checks +> make dev # Configure a "developer" build with tests and checks using OpenSSL 1.1 +> make dev3 # Configure a "developer" build with tests and checks using OpenSSL 3.0 > make test # Builds and runs tests > make format # Runs clang-format over the source ```