# Sample Makefile to build simple project.
#
# This Makefile expect all source files (.c) to be at the same level, in the
-# current working directory.
+# $(SRC_PATH) directory.
+#
+# This Makefile expect all embedded library source files (.c) to be at the same level, in the
+# $(LIBRARY_PATH) directory.
#
# It will automatically generate dependencies, compile all files, and produce a
-# binary using the provided name.
+# binary using the provided name linked against the library if necessary.
#
# Set BINARY_NAME to the name of the binary file to build.
-# Set BUILD_TYPE to either debug or release
+# Set LIBRARY_NAME to the name of the library file to build.
+# The default path for the library code and object is lib.
+# By default the linker will look for $(BINARY_NAME) library name.
+# Set BUILD_TYPE to either debug or release.
#
# Automatic dependencies code from:
# http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/#tldr
OPTI_FLAG = -O3
endif
-# Puting header files in the source directory is not the purpose of this INCLUDES variable
+# Putting header files in the source directory is not the purpose of this INCLUDES variable
INCLUDES := $(INCLUDES) -I$(SRC_PATH) -I$(LIBRARY_PATH)
CFLAGS := $(CFLAGS) $(WARN_FLAGS) $(STD_FLAG) $(OPTI_FLAG) $(DEBUG_FLAG) $(INCLUDES)
LIBCFLAGS := -fPIC $(CFLAGS)