From 876129f05f57899be91df2d348d85a36193dd8c7 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Thu, 26 May 2022 19:05:35 +0200 Subject: [PATCH] Added how2compile to readme --- readme.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/readme.md b/readme.md index 0ecc371..6d47b12 100644 --- a/readme.md +++ b/readme.md @@ -40,6 +40,17 @@ and instruct your compiler to look in `GCryptLib/include` for include files. From there you could either hand all files in `GCryptLib/src/` to your compiler to compile, or precompile it, and link it. An example on how to use GCrypt in a project is right in here: GCryptCLI. +### Compiling the library, tests, and example projects (in `/GCryptLib/exec/`) +#### Prerequisites +1) Make sure to have build-essentials, git, make, and cmake installed, and up-to-date. + +#### Procedure +1) First, you have to pull all the submodules: `git submodule update --init --recursive`. +2) Then, cd into the GCryptLib directory: `cd GCryptLib`. +3) Run cmake: `cmake -B build`. +4) cd into the build directory: `cd build`. +5) Compile: `make`. + ### Working with strings ```cpp using namespace Leonetienne::GCrypt;