docs/tech/tn0001.txt

   1                     How to add a new sample to wxWindows.
   2                     =====================================
   3
   4 To add a new sample "foo" under directory "samples/foo" you need to
   5 do the following:
   6
   7 1. Create the directory samples/foo locally and "cvs add" it
   8
   9 2. Put the sources, headers and foo.rc file in it and "cvs add" them too
  10    (don't forget to use "-kb" switch for binary files)
  11
  12 3. Create the makefiles for Windows compilers. There are several ways to do
  13    it:
  14    a) copy the makefiles from samples/minimal, replace all occurences of
  15       minimal with foo
  16    b) use makegen (sources are under utils/makegen)
  17    c) use projgen
  18
  19 4. Modify configure.in and samples/configure.in for Unix compilation:
  20    a) if the sample should only be built if "wxUSE_FOO" is enabled, locate
  21       the test for "wxUSE_FOO = yes" in configure.in and add a line
  22       SAMPLES_SUBDIRS="$SAMPLES_SUBDIRS foo" under it
  23    b) if it should be always built, locate the line "if test $wxUSE_GUI = yes"
  24       near the end of configure.in and modify the assignment to
  25       SAMPLES_SUBDIRS to include "foo" (put in alphabetical order)
  26    c) add foo/Makefile to AC_OUTPUT in samples/configure.in
  27
  28    After this, regenerate configure and samples/configure from configure.in by
  29    running "autoconf" on a Unix system in the corresponding directory.
  30
  31 Author:  VZ
  32 Version: $Id$
  33
  34 $Log$
  35 Revision 1.1  2000/03/02 04:18:53  GRG
  36 Renamed tech notes to tnxxxx.txt
  37
  38 Revision 1.2  2000/03/01 19:24:07  VZ
  39 added a note about where to find makegen
  40
  41 Revision 1.1  2000/03/01 19:22:41  VZ
  42 created 'how to add a sample' technote