From 859527e2497adad48727d049b667e98295f8b6a0 Mon Sep 17 00:00:00 2001 From: Damiano Boppart Date: Thu, 17 Jan 2019 16:22:02 +0100 Subject: [PATCH] Add basic build instructions --- readme.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..cbc9b7d --- /dev/null +++ b/readme.md @@ -0,0 +1,23 @@ +# How to build + +To customize your build, you may change several variables that are consumed by make. + +These variables, along with some explanations can be found in Makefile.conf. + +You can edit that file, or create a file `local.conf` in the root of the repository, which will also be parsed by make. + +A sample `local.conf` looks like this: + +~~~ +PREFIX=$(HOME)/code/libad/build + +ENGINE_LIB=-L$(HOME)/code/engine/build/lib +ENGINE_INC=-I$(HOME)/code/engine/build/include +~~~ + +Now, run: + +~~~ +make all +make install +~~~