wxWidgets/docs/release.md
Vadim Zeitlin e8fbf9aa49 Also mention wxwidgets.props in the release notes
Explain how to use the MSVC binaries in the new projects. We could also
link to https://docs.wxwidgets.org/3.1.3/plat_msw_binaries.html, but
it's arguably better to add this small note here.
2019-10-27 19:11:27 +01:00

114 lines
8.7 KiB
Markdown

Welcome to wxWidgets, a free and open source cross-platform C++ framework for writing advanced GUI applications using native controls.
wxWidgets 3.1.3 is the latest release in the 3.1 development branch. This release is a "development" one as it makes (very few) incompatible API changes compared to 3.0 and does not guarantee the ABI stability, unlike the 3.0.x series. It is not inherently more buggy or less stable than the "stable" releases and you're encouraged to use it, including in production. If you're already using 3.0, upgrading shouldn't require any special effort, so please try it out.
Please see [**README**](https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.3/docs/readme.txt) for more information about this release and the [change log](https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.3/docs/changes.txt) for the details of the changes in it.
## Source Files and Documentation
If you intend to build wxWidgets from sources (which is recommended), please do **NOT** download the files using the "Source code" links just above, which are automatically generated by GitHub and don't contain the submodules sources which are necessary for building wxWidgets.
Instead, download one of [wxWidgets-3.1.3.zip](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.3/wxWidgets-3.1.3.zip) or [wxWidgets-3.1.3.7z](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.3/wxWidgets-3.1.3.7z), for much smaller size, for Microsoft Windows systems or [wxWidgets-3.1.3.tar.bz2](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.3/wxWidgets-3.1.3.tar.bz2) for Unix ones, including macOS. These archives have exactly the same contents, but use the line endings appropriate for the corresponding platform.
In addition, we provide archives containing the documentation in either HTML or Microsoft CHM formats. Notice that the documentation is also [available online](https://docs.wxwidgets.org/3.1.3).
Finally, Microsoft Windows users may download [Setup.exe file](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.3/wxMSW-3.1.3-Setup.exe) containing both sources and documentation, however please note that this file does _not_ contain any binaries, please see below for those.
To verify your download please use the following SHA-1 checksums:
393a91afb64ee989bf986677a4aa5597acf6ed6d wxMSW-3.1.3-Setup.exe
b62a17569f2229eb60f5ebd1abfb2a551dea4969 wxWidgets-3.1.3-docs-chm.zip
13f374c4ddef7f5e5a1a209704a9b314469b00ff wxWidgets-3.1.3-docs-html.tar.bz2
8ddaeb0ffd8478c90d7e2c5f241988704962952f wxWidgets-3.1.3-docs-html.zip
d3b59e1b178f14b6f238f8bde70a29ba80a70990 wxWidgets-3.1.3-headers.7z
19b42dce10c93f90257c0c87af527bfa8d756a0a wxWidgets-3.1.3.7z
18be15d7a9e5b733e647677d3e9bc476df727f73 wxWidgets-3.1.3.tar.bz2
40112ee7dc4262b46cc4475145db96488bcd64ff wxWidgets-3.1.3.zip
## Binaries
We provide pre-built binary files for the following compilers:
* Microsoft Visual C++ compiler versions 9.0, 10.0, 11.0, 12.0, 14.0, 14.1 and 14.2 (corresponding to marketing product names of Microsoft Visual Studio 2008, 2010, 2012, 2013, 2015, 2017 and 2019 respectively).
* TDM-GCC version 5.1 and MinGW-w64 versions 7.3 and 8.1 (with the default SJLJ exceptions propagation method, using C++11).
### For Developers
For developing applications with wxWidgets you need to download the compiler-independent `wxWidgets-3.1.3_Headers.7z` file and one of `wxMSW-3.1.3-vcXXX_Dev.7z` or `wxMSW-3.1.3_gccXXX_Dev.7z` files depending on your compiler, its version and the target architecture (x86 if not specified or x64).
Unpack both files into the same directory so that `include` and `lib` directories are at the same level after unpacking. You should be able to compile and link applications using wxWidgets in both debug and release modes but the debug symbols are provided only for debug libraries in this archive, see below for the release build debug symbols.
Note that if you're setting up a new project using these binaries, the simplest
way to do it is to use the provided `wxwidgets.props` file: for this, open the
`View|Property Manager` menu item in the IDE, select "Add Existing Property
Sheet..." from the project context menu and browse to this file in the file
open dialog.
### For End Users
End users may download one of `wxMSW-3.1.3_vcXXX_ReleaseDLL.7z` or `wxMSW-3.1.3_gccXXX_ReleaseDLL.7z` files to get just the DLLs required for running the applications using wxWidgets.
### For Debugging
* Microsoft Visual C++ users: Files `wxMSW-3.1.3_vcXXX_ReleasePDB.7z` contain the debug symbols for the release build of the DLLs. Download them if you want to debug your own applications in release build or if you want to get meaningful information from mini-dumps retrieved from your users machines.
* MinGW-TDM users: Currently the debug symbols are not available for the release build of the DLLs (only the debug versions of the DLLs contains the debug symbols).
### Binary File Download Verification
To verify your download please use the following SHA-1 checksums:
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc510TDM_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc510TDM_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc510TDM_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc510TDM_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc730_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc730_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc730_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc730_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc810_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc810_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc810_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_gcc810_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc90_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc90_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc90_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc90_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc90_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc90_x64_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc100_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc100_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc100_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc100_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc100_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc100_x64_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc110_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc110_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc110_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc110_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc110_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc110_x64_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc120_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc120_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc120_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc120_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc120_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc120_x64_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc140_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc140_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc140_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc140_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc140_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc140_x64_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc141_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc141_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc141_ReleasePDB.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc141_x64_Dev.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc141_x64_ReleaseDLL.7z
0000000000000000000000000000000000000000 wxMSW-3.1.3_vc141_x64_ReleasePDB.7z
## Reporting Problems
Please report bugs to the [issue tracker](https://trac.wxwidgets.org/newticket) or the [wx-users mailing list](http://groups.google.com/group/wx-users).