projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| d81a8f2e VZ |
1 | How to add a new sample to wxWindows. |
| 2 | ===================================== | |
| 3 | ||
| 03bbd98b GRG |
4 | To add a new sample "foo" under directory "samples/foo" you need to do |
| 5 | the following: (note that all this applies also to demos: just replace | |
| 6 | samples/ with demos/ where needed). | |
| d81a8f2e VZ |
7 | |
| 8 | 1. Create the directory samples/foo locally and "cvs add" it | |
| 9 | ||
| 10 | 2. Put the sources, headers and foo.rc file in it and "cvs add" them too | |
| 11 | (don't forget to use "-kb" switch for binary files) | |
| 12 | ||
| 13 | 3. Create the makefiles for Windows compilers. There are several ways to do | |
| 14 | it: | |
| 15 | a) copy the makefiles from samples/minimal, replace all occurences of | |
| 16 | minimal with foo | |
| 77c43587 | 17 | b) use makegen (sources are under utils/makegen) |
| d81a8f2e VZ |
18 | c) use projgen |
| 19 | ||
| 20 | 4. Modify configure.in and samples/configure.in for Unix compilation: | |
| 21 | a) if the sample should only be built if "wxUSE_FOO" is enabled, locate | |
| 22 | the test for "wxUSE_FOO = yes" in configure.in and add a line | |
| 23 | SAMPLES_SUBDIRS="$SAMPLES_SUBDIRS foo" under it | |
| 24 | b) if it should be always built, locate the line "if test $wxUSE_GUI = yes" | |
| 25 | near the end of configure.in and modify the assignment to | |
| 26 | SAMPLES_SUBDIRS to include "foo" (put in alphabetical order) | |
| 27 | c) add foo/Makefile to AC_OUTPUT in samples/configure.in | |
| 28 | ||
| 03bbd98b GRG |
29 | After this, regenerate configure and samples/configure from configure.in |
| 30 | by running "autoconf" on a Unix system in the corresponding directory. | |
| 31 | ||
| 32 | 5. Add a short description of what the sample does and how does it work | |
| 33 | to the "samples overview" section in the wxWindows manual. That section | |
| 34 | lives in docs/latex/wx/tsamples.tex; look at the descriptions for other | |
| 35 | samples, if you are not familiar with LaTeX. | |
| 36 | ||
| 37 | === EOF === | |
| d81a8f2e VZ |
38 | |
| 39 | Author: VZ | |
| 40 | Version: $Id$ | |
| 77c43587 VZ |
41 | |
| 42 | $Log$ | |
| 03bbd98b GRG |
43 | Revision 1.2 2000/03/06 16:50:13 GRG |
| 44 | Added a mention about demos/ instead of samples/ | |
| 45 | Added a mention of the 'samples overview' section in the wxWindows manual | |
| 46 | Added EOF marker to easily distinguish the text from the CVS log. | |
| 47 | ||
| 1cab5b8d GRG |
48 | Revision 1.1 2000/03/02 04:18:53 GRG |
| 49 | Renamed tech notes to tnxxxx.txt | |
| 50 | ||
| 77c43587 VZ |
51 | Revision 1.2 2000/03/01 19:24:07 VZ |
| 52 | added a note about where to find makegen | |
| 53 | ||
| 54 | Revision 1.1 2000/03/01 19:22:41 VZ | |
| 55 | created 'how to add a sample' technote |