Skip to content
Browse files

Documentation!

  • Loading branch information...
1 parent 53ebde5 commit 388291c5e24f28a12837f17e4c17369cef868e9a Dirk Nederveen (farnsworth) committed
Showing with 35 additions and 0 deletions.
  1. +5 −0 README
  2. +30 −0 VARIABLES
View
5 README
@@ -0,0 +1,5 @@
+# cpp.mk
+Cpp.mk is a quick to set up makefile for C++ (and C if you're lucky) projects.
+
+## Variables
+cpp.mk offers plenty of variables that you can set to customize your build system, look into the file VARIABLES for more information.
View
30 VARIABLES
@@ -0,0 +1,30 @@
+These variables can be modified in either your own Makefile or on the command line.
+
+# CXX
+Use this variable to set the compiler binary you'd like to invoke.
+Default: c++
+Example: make CXX=g++-4.6
+
+# CXXFLAGS
+With this variable you can set compiler flags.
+Default: -Wall -pedantic
+Example: make CXXFLAGS="-std=c++0x"
+
+# DEBUG_CONSTANT
+The preprocessor constant you use to signal the debug level
+Default: _DEBUG
+Example: make DEBUG_CONSTANT=DBG
+
+# DBG
+The debug level you want to compile with, uses DEBUG_CONSTANT.
+Without this variable, " -O2 -s" will be added to CXXFLAGS;
+with this variable, " -g -D$(DEBUG_CONSTANT)=$(DBG)" will be added to CXXFLAGS.
+Example: make DBG=1
+
+# DEPEND
+The filename you use for keeping your make-depend file.
+Default: make.dep
+
+# ALLTARGET
+The target name you use as default target. Don't bother with this if you include cpp.mk at the end of your Makefile.
+Default: all

0 comments on commit 388291c

Please sign in to comment.
Something went wrong with that request. Please try again.