X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/657477c45e9d3f44c2b386e6cb23e12b331e1b0d..066f3611df971be93b2ec46b82c2f05f3ff9a422:/docs/tech/tn0001.txt diff --git a/docs/tech/tn0001.txt b/docs/tech/tn0001.txt index 2cbf0cc6f1..68d9a98567 100644 --- a/docs/tech/tn0001.txt +++ b/docs/tech/tn0001.txt @@ -1,4 +1,4 @@ - How to add a new sample to wxWindows. + How to add a new sample to wxWidgets. ===================================== To add a new sample "foo" under directory "samples/foo" you need to do @@ -27,25 +27,31 @@ samples/ with demos/ where needed). 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" to generate just the makefiles for the given - compiler (run 'bakefile --help' to get the list of possible values) + compiler (run 'bakefile --help' to get the list of possible values). + See Technote #16 for more information. -4. Modify configure.in and samples/configure.in for Unix compilation: +4. Modify configure.in 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 + After this, regenerate 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 + to the "samples overview" section in the wxWidgets manual. That section lives in docs/latex/wx/tsamples.tex; look at the descriptions for other samples, if you are not familiar with LaTeX. +6. Add any non-standard sample's files to build/bakefiles/make_dist.mk (the + makefiles copies all bmp, cpp, h, ico, png, rc, xpm and makefiles by + default, you only need to update it if the sample uses some other files) + and run the ./update-manifests.sh script in distrib/scripts (don't forget + to check the changes to manifests/*.rsp files in). + === EOF === Author: VZ