Split configuration into project-wide and local

[software/makeit.git] / example / README

diff --git a/example/README b/example/README
index e3b8addaf5d5cdac6eb1dc954a5708be79bcca7e..b0cc392877cb1440a220c723729f8545234b9c9f 100644 (file)
--- a/example/README
+++ b/example/README
@@ -1,10 +1,16 @@
 
 

-This is a test/example for a nice Make based build system.
+This is a test/example for the Makeit build system.

 
 

-The Config.mak should not be saved to the repositories usually, but in this
-case it is because part of this demonstration is to show how to customize the
-build system through Config.mak, and specially to show how a project can be
-"embedded" into another tweaking the Config.mak.
+The Config.local.mak should not be saved to the repositories usually, it's
+supposed to be user configuration not visible to other users, but in
+this case it is because is part of this demonstration. Also, subproj's
+Config.local.mak shows how to make another project using Makeit behave as it was
+part of this project, as an "embedded" sub-project.
+
+This means you could copy subproj directory elsewhere, remove Config.local.mak
+and that should be a standalone project using Makeit. Tweaking ours
+Config.local.mak here, we integrate it into the build system, so doing make in
+our parent project will make subproj too.

 
 lib1 is a standalone C library compiled into a shared object.  lib2 is another
 shared library which uses lib1 and otherproj, which is a standalone project
 
 lib1 is a standalone C library compiled into a shared object.  lib2 is another
 shared library which uses lib1 and otherproj, which is a standalone project


@@ -12,8 +18,8 @@ shared library which uses lib1 and otherproj, which is a standalone project
 produces another standalone shared object.  Finally, prog is a program which
 uses lib1 and lib2.
 
 produces another standalone shared object.  Finally, prog is a program which
 uses lib1 and lib2.
 

-Every project have it's copy of Makeit.mak and it's own Toplevel.mak. Both
-files shouldn't be modified ever (unless you're hacking the build system).
+Every standalone project have it's copy of Makeit.mak and it's own Toplevel.mak.
+Both files shouldn't be modified ever (unless you're hacking the build system).

 
 Then each directory containing some library or program to build (or directories
 to include) has a Build.mak, which has only the logic to build the
 
 Then each directory containing some library or program to build (or directories
 to include) has a Build.mak, which has only the logic to build the