Update README.md
This commit is contained in:
parent
67a8e2452f
commit
b072c3bbbd
1 changed files with 11 additions and 0 deletions
11
README.md
11
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 <AnotherMemCheck_project_dir> -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 <project_dir> -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.
|
||||
|
|
Loading…
Reference in a new issue