a magical makefile, using a collection of submakefiles that are completely reusable without modifications

Signed-off-by: Mattias Andrée <maandree@member.fsf.org>

1 files changed, 49 insertions, 0 deletions

diff --git a/mk/README b/mk/README
new file mode 100644
index 0000000..fd27fd0
--- /dev/null
+++ b/mk/README
@@ -0,0 +1,49 @@
+This is a collection of generic enough makefiles.
+Please feel free to use them in your project.
+
+Usage:
+	Include all.mk from your makefile.
+
+	It is a good idea to include path.mk before you define
+	path variables.
+
+	Read the top of each file for details.
+
+	Define the variables:
+
+		_VERSION
+		This version of the package.
+
+		_PROJECT
+		The name of the project. Must only include [a-z0-9_-].
+
+		_PROJECT_FULL
+		The name of the project. May include any character.
+
+		_SRC
+		All source code files. This list is used when
+		generating the translation template file.
+
+		_COPYRIGHT_HOLDER
+		The copyright holder's full name and e-mail address.
+
+		COMMAND
+		The name of the command. Must not be declared if
+		the package does not include exactly one runnable
+		command.
+
+		PKGNAME
+		The name of the package.
+
+	Variables beginning with __ are used internally by
+	the files where they appear, or in rare cases,
+	internally between these files.
+
+	Variables beginning with _ but not __ are set in the
+	makefile to specify for these files how they should
+	behave. They should not be changed by a user of the
+	package.
+
+	Variables that do not begin with _ are configurable
+	by the user of the package.
+