From f4a58a96bc15421a21432829dbcc0b94d33e3f0a Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Fri, 14 Feb 2020 13:44:02 -0800 Subject: [PATCH] docs: add build instructions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f457529..b6d1546 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,17 @@ `uvwasi` implements the [WASI][] system call API. Under the hood, `uvwasi` leverages [libuv][] where possible for maximum portability. +## Building Locally + +To build with [CMake](https://cmake.org/): + +```sh +$ mkdir -p out/cmake ; cd out/cmake # create build directory +$ cmake ../.. -DBUILD_TESTING=ON # generate project with test +$ cmake --build . # build +$ ctest -C Debug --output-on-failure # run tests +``` + ## Example Usage ```c