From 7ae238e5be1f36e7cf079193b634211c5b8c4f12 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Tue, 16 Sep 2003 17:37:40 +0000
Subject: [PATCH] updated makefiles generation section

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@23622 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/tech/tn0001.txt | 34 ++++++++++++++++++++++++----------
 1 file changed, 24 insertions(+), 10 deletions(-)

diff --git a/docs/tech/tn0001.txt b/docs/tech/tn0001.txt
index ab28c3bd1e..02015b4789 100644
--- a/docs/tech/tn0001.txt
+++ b/docs/tech/tn0001.txt
@@ -5,16 +5,30 @@ To add a new sample "foo" under directory "samples/foo" you need to do
 the following: (note that all this applies also to demos: just replace
 samples/ with demos/ where needed).
 
-1. Create the directory samples/foo locally and "cvs add" it
-
-2. Put the sources, headers and foo.rc file in it and "cvs add" them too
-   (don't forget to use "-kb" switch for binary files)
-
-3. Create the makefiles for Windows compilers. There are several ways to do
-   it:
-   a) copy the makefiles from samples/minimal, replace all occurrences of
-      minimal with foo
-   b) use bakefile (http://bakefile.sourceforge.net/)
+1. Create the directory samples/foo locally and "cvs add" it.
+
+2. "cvs add" the sample sources (usually based on minimal.cpp) as well.
+
+   Note that unless your sample requires something special you shouldn't
+   add foo.rc, foo.ico, ... any more, please just reuse the generic sample.*
+   files in the samples subdirectory.
+
+3. Create the makefiles:
+   a) modify samples/samples.bkl (just copy an existing line)
+   b) create foo.bkl (sed 's/minimal/foo/g' minimal.bkl > foo.bkl is usually
+      enough, but you may need to add more <wx-lib> lines if your sample uses
+      anything not in the core lib)
+   c) generate the makefiles for your sample using bakefile. For this you
+      need to:
+      (i) install bakefile (see http://bakefile.sf.net/)
+      (ii) run bakefile_gen in build/bakefiles which will regenerate all
+           makefiles which are not up to date
+
+      You may also use "bakefile_gen -b ../../samples/foo/foo.bkl" to
+      regenerate only the makefiles for this sample (path must be relative!)
+      or even add a "-f<compiler>" to generate just the makefiles for the given
+      compiler (possible values are in FORMATS.bkmanifest file in bakefile
+      source tree)
 
 4. Modify configure.in and samples/configure.in for Unix compilation:
    a) if the sample should only be built if "wxUSE_FOO" is enabled, locate
-- 
2.45.2