From: Daniel Karbach <daniel.karbach@localhorst.tv>
Date: Wed, 11 Mar 2015 12:45:18 +0000 (+0100)
Subject: add building notes
X-Git-Url: https://git.localhorst.tv/?a=commitdiff_plain;h=d66d14f853f2d05f54076d38c72e53419dfc4cc5;p=blank.git

add building notes
---

diff --git a/building b/building
new file mode 100644
index 0000000..4163862
--- /dev/null
+++ b/building
@@ -0,0 +1,48 @@
+Dependencies
+============
+
+	GLEW, GLM, SDL2, SDL2_image
+
+archlinux: pacman -S glew glm sdl2 sdl2_image
+
+
+Makefile
+========
+
+Targets
+-------
+
+all:
+	build everything
+
+release (default), debug, profile:
+	build executables tuned for running, debugging, and profiling
+
+run:
+	build and execute the main binary
+
+gdb, cachegrind, callgrind:
+	build the binary suited for given tool and launch
+
+clean:
+	remove intermediates
+
+distclean:
+	remove intermediates and artifacts
+	(also those generated by tool invocations!)
+
+
+Variables
+---------
+
+CXX, LXX:
+	compiler/linker used for C++ sources/objects
+
+LIBS:
+	names of libraries (for pkg-config)
+
+CPPFLAGS, CXXFLAGS, LDXXFLAGS:
+	flags for the preprocessor, compiler, and linker
+
+DEBUG_FLAGS, PROFILE_FLAGS, RELEASE_FLAGS:
+	flags for building binaries in debug, profile, and release mode