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

Update bakefile-related information in the docs

Browse Source 
Mention that we use the legacy 0.2 bakefile branch.

Also use https://www.bakefile.org/ as Bakefile home page location.

Finally, use backticks around more files names, especially those
containing asterisks, that break Markdown syntax highlighting in Vim
otherwise.
This commit is contained in:
Vadim Zeitlin
2019-10-06 23:14:43 +02:00
parent 86fab39ac9
commit 29781b1752
3 changed files with 62 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -10,17 +10,17 @@ samples/ with demos/ where needed).
2. "git add" the sample sources (usually based on minimal.cpp) as well.
Note that unless your sample requires something special you shouldn't
add foo.rc, foo.ico, ... any more, please just reuse the generic sample.*
add foo.rc, foo.ico, ... any more, please just reuse the generic `sample.*`
files in the samples subdirectory.
3. Create the makefiles:
- modify samples/samples.bkl (just copy an existing line)
- create foo.bkl (`sed 's/minimal/foo/g' minimal.bkl > foo.bkl` is usually
enough, but you may need to add more `<wx-lib>` lines if your sample uses
anything not in the core lib)
enough, but you may need to add more `<wx-lib>` lines if your sample uses
anything not in the core lib)
- generate the makefiles for your sample using bakefile. For this you
need to:
- install bakefile (see http://bakefile.sf.net/)
need to:
- install bakefile (see docs/contributing/how-to-add-files-to-build-system.md)
- run bakefile_gen in build/bakefiles which will regenerate all
makefiles which are not up to date
@@ -29,8 +29,6 @@ samples/ with demos/ where needed).
or even add a `-f<compiler>` to generate just the makefiles for the given
compiler (run `bakefile --help` to get the list of possible values).
See how-to-add-files-to-build-system.md for more information.
- currently samples/samples.dsw needs to be updated manually as it's not
generated by bakefile.
4. Modify configure.in Unix compilation:
- if the sample should only be built if `wxUSE_FOO` is enabled, locate
@@ -56,8 +54,7 @@ samples/ with demos/ where needed).
lives in docs/doxygen/mainpages/samples.h; look at the descriptions for
other samples, if you are not familiar with Doxygen.
7. 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
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).
and run the ./update-manifests.sh script in distrib/scripts.