From 0e1e438d558b6bf8cd3a831aa8144d522ea8fbfe Mon Sep 17 00:00:00 2001 From: Michele Caini Date: Mon, 10 Oct 2016 10:01:38 +0200 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 384db10d..8dbf4f2d 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,21 @@ The main reason for which `uvw` has been written is the fact that it does not ex # Build Instructions +## Requirements + +To be able to use `uvw`, users must provide the following system-wide tools: + +* A full-featured compiler that supports at least C++14 +* `libuv` version 1.9.0 or successive + +The requirements below are mandatory to compile the tests and to extract the documentation: + +* CMake version 3.4 or successive +* Doxygen version 1.8 or successive + +Note that `libuv` is part of the dependencies of the project and it will be cloned by executing the script `deps.sh` (see below for further details).
+Because of that, users have not to install it to compile and execute the tests. + ## Library `uvw` is a header-only library.