From 2f567a8603038932833f0e4f9edb863dc362c285 Mon Sep 17 00:00:00 2001 From: Benson Muite Date: Sun, 28 Jan 2024 19:00:02 +0300 Subject: [PATCH] Add information about header install location (#116) --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index a6d2de9..2cfb924 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,9 @@ Several examples exist in the [example folder](https://github.com/dougbinks/enk For further examples, see https://github.com/dougbinks/enkiTSExamples +On Linux and Mac OS X, the header files are installed in a subdirectory of the include path, `include/enkiTS` to ensure that they do not conflict with header files from other packages. +When building applications either ensure this is part of the INCLUDE_PATH variable or ensure that enkiTS is in the header path in the source files, for example use `#include "enkiTS/TaskScheduler.h"` instead of `#include "TaskScheduler.h"`. + ## Building Building enkiTS is simple, just add the files in enkiTS/src to your build system (_c.* files can be ignored if you only need C++ interface), and add enkiTS/src to your include path. Unix / Linux builds will likely require the pthreads library.