From 79163819973acb81af2a49e6859cb4776f63471e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Dunglas?= Date: Tue, 12 Nov 2024 22:53:10 +0100 Subject: [PATCH] docs: add cmake instructions --- readme.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/readme.md b/readme.md index e33009ab..695f0c20 100644 --- a/readme.md +++ b/readme.md @@ -10,6 +10,16 @@ [![Android Compilation Tests](https://github.com/e-dant/watcher/actions/workflows/android.yml/badge.svg)](https://github.com/e-dant/watcher/actions/workflows/android.yml) [![Windows Tests](https://github.com/e-dant/watcher/actions/workflows/windows.yml/badge.svg)](https://github.com/e-dant/watcher/actions/workflows/windows.yml) +## Install + +Follow these instructions to compile and install the C++ library, the C library and the binary: + +```console +cmake -S . -B build -DCMAKE_BUILD_TYPE=Release +cmake --build build +cmake --install build +``` + ## Quick Start