aboutsummaryrefslogtreecommitdiff
path: root/externals/build/README
diff options
context:
space:
mode:
Diffstat (limited to 'externals/build/README')
-rw-r--r--externals/build/README16
1 files changed, 12 insertions, 4 deletions
diff --git a/externals/build/README b/externals/build/README
index 8c547a2f..250e6918 100644
--- a/externals/build/README
+++ b/externals/build/README
@@ -33,14 +33,14 @@ Externals That Need Libraries
In order to add an external that needs libraries to this build system, create
a "libs" file with the exact same name as the source file (i.e. oggread~.c and
oggread~.libs). If the .libs file has cross-platforms library options, it
-should go into externals/build/src. .libs files for platform-specific library
-options go in externals/build/PLATFORM (see TODO, this is totally implemented).
+should go into "externals/build/src". .libs files for platform-specific library
+options go in "externals/build/PLATFORM"
Externals That Are Built From Multiple Files
============================================
-In the externals/build/src/*. file, #include the other files that need to be
+In your "externals/build/src/OBJECT.c" file, #include the other files that need to be
compiled and linked in. See how the chaos externals are included:
attract1.c:#include "../../bbogart/chaos/lyapunov.c"
@@ -56,6 +56,14 @@ dejong.c:#include "../../bbogart/chaos/lyapunov.c"
dejong.c:#include "../../bbogart/chaos/dejong.c"
+Help Files
+==========
+
+The help files are copied to "externals/build/doc" by the makefile that is in
+that directory. To add yours, create a line that copies your help files to
+"externals/build/doc". Currently the list of help files to be added in this
+makefile is in alphabetical order by directory name.
+
Problems with this approach
===========================
@@ -64,7 +72,7 @@ Problems with this approach
- it might be hard for externals that use several source files
- I could not find a way how this should work on windows with nmake ..
- for now I just put the windows links in build/win/*.c. This should be
+ for now I just put the windows links in "build/win/*.c". This should be
converted to a MinGW GNU Makefile, then it would work the same as on the
other platforms.