From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 1 Mar 2000 19:22:41 +0000 (+0000)
Subject: created 'how to add a sample' technote
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/d81a8f2ece7e71b9f85b52805c6181165af27352

created 'how to add a sample' technote


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6382 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/tech/1.txt b/docs/tech/1.txt
new file mode 100644
index 0000000000..5d735c2d2e
--- /dev/null
+++ b/docs/tech/1.txt
@@ -0,0 +1,36 @@
+                    How to add a new sample to wxWindows.
+                    =====================================
+
+To add a new sample "foo" under directory "samples/foo" you need to
+do the following:
+
+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 occurences of
+      minimal with foo
+   b) use makegen
+   c) use projgen
+
+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
+      the test for "wxUSE_FOO = yes" in configure.in and add a line
+      SAMPLES_SUBDIRS="$SAMPLES_SUBDIRS foo" under it
+   b) if it should be always built, locate the line "if test $wxUSE_GUI = yes"
+      near the end of configure.in and modify the assignment to
+      SAMPLES_SUBDIRS to include "foo" (put in alphabetical order)
+   c) add foo/Makefile to AC_OUTPUT in samples/configure.in
+
+   After this, regenerate configure and samples/configure from configure.in by
+   running "autoconf" on a Unix system in the corresponding directory.
+
+Author:  VZ
+Version: $Id$
+History: $Log$
+History: Revision 1.1  2000/03/01 19:22:41  VZ
+History: created 'how to add a sample' technote
+History: