03bbd98b9c
Added a mention of the 'samples overview' section in the wxWindows manual Added EOF marker to easily distinguish the text from the CVS log. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6477 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
56 lines
2.2 KiB
Plaintext
56 lines
2.2 KiB
Plaintext
How to add a new sample to wxWindows.
|
|
=====================================
|
|
|
|
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 occurences of
|
|
minimal with foo
|
|
b) use makegen (sources are under utils/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.
|
|
|
|
5. Add a short description of what the sample does and how does it work
|
|
to the "samples overview" section in the wxWindows manual. That section
|
|
lives in docs/latex/wx/tsamples.tex; look at the descriptions for other
|
|
samples, if you are not familiar with LaTeX.
|
|
|
|
=== EOF ===
|
|
|
|
Author: VZ
|
|
Version: $Id$
|
|
|
|
$Log$
|
|
Revision 1.2 2000/03/06 16:50:13 GRG
|
|
Added a mention about demos/ instead of samples/
|
|
Added a mention of the 'samples overview' section in the wxWindows manual
|
|
Added EOF marker to easily distinguish the text from the CVS log.
|
|
|
|
Revision 1.1 2000/03/02 04:18:53 GRG
|
|
Renamed tech notes to tnxxxx.txt
|
|
|
|
Revision 1.2 2000/03/01 19:24:07 VZ
|
|
added a note about where to find makegen
|
|
|
|
Revision 1.1 2000/03/01 19:22:41 VZ
|
|
created 'how to add a sample' technote
|