From b072c3bbbda818bbde6db097cc7c261e6a20a158 Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Tue, 4 Jun 2024 12:21:59 +0900 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b168754..c440dde 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ This software was created as an alternative to valgrind/memcheck. +## How to Build + +1. Install cmake. +2. Run `cmake -S -B buildDebug`. +3. Run `make -C buildDebug`. The output library should be in the buildDebug/ + directory. + +If a release build is desired, use `cmake -S -B buildRelease +-DCMAKE_BUILD_TYPE=Release`. (Note that the "build directory" was changed to +"buildRelease" in the preceeding command.) + ## Usage 1. Build this software with cmake.