From 2a0fa294bcdb487d2f2356099e3ea02336148478 Mon Sep 17 00:00:00 2001
From: Thibault Hallouin <thibault.hallouin@inrae.fr>
Date: Thu, 1 Dec 2022 16:11:24 +0100
Subject: [PATCH] draft readme with building and testing instructions

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 6b752f9..ec9c8ea 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,20 @@
 Utility to evaluate deterministic and probabilistic streamflow predictions
 
 Documentation: https://hycar-hydro.gitlab.irstea.page/evalhyd/evalhyd-docs/cpp
+
+## How to build
+
+Configure project in debug mode finding libraries in conda environment:
+```shell
+cmake -B build/ -D CMAKE_BUILD_TYPE=Debug -D CMAKE_PREFIX_PATH="$CONDA_PREFIX"
+```
+
+Compile with:
+```shell
+cmake --build build/ --parallel 2
+```
+
+Run tests with:
+```shell
+./build/tests/evalhyd_tests  
+```
-- 
GitLab