Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Include CMake in how to add new sample docs

Browse Source
This commit is contained in:
Tobias Taschner
2018-10-24 10:37:52 +02:00
parent 2ad0c1b7e1
commit d433aa7821
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing/how-to-add-new-sample.md
View File

@@ -43,12 +43,20 @@ samples/ with demos/ where needed).
After this, regenerate configure from configure.in After this, regenerate configure from configure.in
by running "autoconf" on a Unix system in the corresponding directory. 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 5. Modify `build/cmake/samples/CMakeLists.txt` to include the sample in
CMake. Add a new line like this:
wx_add_sample(foo DEPENDS wxUSE_FOO)
For a complete list of parameters to the `wx_add_sample()` function see
the description in `build/cmake/functions.cmake`.
6. Add a short description of what the sample does and how does it work
to the "samples overview" section in the wxWidgets manual. That section to the "samples overview" section in the wxWidgets manual. That section
lives in docs/doxygen/mainpages/samples.h; look at the descriptions for lives in docs/doxygen/mainpages/samples.h; look at the descriptions for
other samples, if you are not familiar with Doxygen. other samples, if you are not familiar with Doxygen.
6. Add any non-standard sample's files to build/bakefiles/make_dist.mk (the 7. 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 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) 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 and run the ./update-manifests.sh script in distrib/scripts (don't forget