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

Describe the available files better in the release notes

Browse Source 
Also mention that GitHub-provided links to the source code should _not_
be used.
This commit is contained in:
Vadim Zeitlin 2018-02-05 23:29:31 +01:00
parent 6961bcb43f
commit 76c75d87f5
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/release.md
View File

@ -4,15 +4,16 @@ Welcome to wxWidgets, a free and open source cross-platform C++ framework for wr
wxWidgets 3.1.1 is the second 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. If you're already using 3.0, upgrading shouldn't require any special effort, so please try it out.
Please notice that we provide a single source distribution containing files for all platforms, so you only need to download either the archive with the `.zip` (or `.7z` for much smaller size) extension for Microsoft Windows systems or the one with `.tar.bz2` extenstion for Unix ones, including Mac OS X.
Please see [**README**](https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.1-rc/docs/readme.txt) for more information about this release and the [change log](https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.1-rc/docs/changes.txt) for details of the changes in it.
See [README](https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.1-rc/docs/readme.txt) for more information about this release and the [change log](https://raw.githubusercontent.com/wxWidgets/wxWidgets/v3.1.1-rc/docs/changes.txt) for details of the changes in it.
## Reporting Problems
## Source Files and Documentation
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).
If you intend to build wxWidgets from sources (which is recommended), please download `wxWidgets-3.1.1-rc` archive in either [ZIP](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.1-rc/wxWidgets-3.1.1-rc.zip) or [7z](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.1-rc/wxWidgets-3.1.1-rc.7z), for much smaller size, format for Microsoft Windows systems or the [compressed tarball](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.1-rc/wxWidgets-3.1.1-rc.tar.bz2) for Unix ones, including macOS. These archives have exactly the same contents, but use the line endings appropriate for the corresponding platform. Be sure to _not_ download the files available from the "Source code" links above, which are automatically generated by GitHub and don't contain the submodules sources which are necessary for building wxWidgets.
## Download Verification
In addition, we provide archives containing the documentation in either HTML or Microsoft CHM formats. Notice that the documentation is also [available online](http://docs.wxwidgets.org/3.1).
Finally, Microsoft Windows users may download [Setup.exe file](https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.1-rc/wxMSW-3.1.1-rc-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:
@ -96,3 +97,8 @@ To verify your download please use the following SHA-1 checksums:
a4b4014c1a1289d798597ebc810a01e88edf53bc wxMSW-3.1.1-rc_vc141_x64_Dev.7z
285afbcc27e18344654183d8b9e6beca9a9eab92 wxMSW-3.1.1-rc_vc141_x64_ReleaseDLL.7z
82685386d8291dd5012ef00ced5fdc45cb0d8a04 wxMSW-3.1.1-rc_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).