3ee52836c6
Rename BuildGit.txt to README-GIT.md, which is a more standard name, and a better format for viewing this file online, e.g. from GitHub Web UI, and link it from the main README to make it easier to find.
76 lines
2.6 KiB
Markdown
76 lines
2.6 KiB
Markdown
About
|
|
-----
|
|
|
|
wxWidgets is a free and open source cross-platform C++ framework
|
|
for writing advanced GUI applications using native controls.
|
|
|
|
|
|
|
|
wxWidgets allows you to write native-looking GUI applications for
|
|
all the major desktop platforms and also helps with abstracting
|
|
the differences in the non-GUI aspects between them. It is free
|
|
for the use in both open source and commercial applications, comes
|
|
with the full, easy to read and modify, source and extensive
|
|
documentation and a collection of more than a hundred examples.
|
|
You can learn more about wxWidgets at https://www.wxwidgets.org/
|
|
and read its documentation online at http://docs.wxwidgets.org/
|
|
|
|
|
|
Platforms
|
|
---------
|
|
|
|
[](https://ci.appveyor.com/project/wxWidgets/wxwidgets)
|
|
[](https://travis-ci.org/wxWidgets/wxWidgets)
|
|
|
|
wxWidgets currently supports the following primary platforms:
|
|
|
|
- Windows XP, Vista, 7, 8 and 10 (32/64 bits).
|
|
- Most Unix variants using the GTK+ toolkit (version 2.6 or newer or 3.x).
|
|
- OS X (10.7 or newer) using Cocoa (32/64 bits).
|
|
|
|
Most popular C++ compilers are supported including but not limited to:
|
|
|
|
- Microsoft Visual C++ 2003 or later (up to 2017).
|
|
- g++ 3.4 or later, including MinGW/MinGW-64/TDM under Windows.
|
|
- Clang under OS X and Linux.
|
|
- Intel icc compiler.
|
|
- Oracle (ex-Sun) aCC.
|
|
|
|
|
|
Licence
|
|
-------
|
|
|
|
[wxWidgets licence](https://github.com/wxWidgets/wxWidgets/blob/master/docs/licence.txt)
|
|
is a modified version of LGPL explicitly allowing not distributing the sources
|
|
of an application using the library even in the case of static linking.
|
|
|
|
|
|
Building
|
|
--------
|
|
|
|
For building the library, please see platform-specific documentation under
|
|
`docs/<port>` directory.
|
|
|
|
If you're building the sources checked out from Git, and not from a released
|
|
versions, please see these additional [Git-specific notes](README-GIT.md).
|
|
|
|
|
|
Further information
|
|
-------------------
|
|
|
|
If you are looking for support, you can get it from
|
|
|
|
- [Mailing Lists](https://www.wxwidgets.org/support/mailing-lists/)
|
|
- [Discussion Forums](https://forums.wxwidgets.org/)
|
|
- [#wxwidgets IRC channel](https://www.wxwidgets.org/support/irc/)
|
|
- [Stack Overflow](https://stackoverflow.com/questions/tagged/wxwidgets)
|
|
(tag your questions with `wxwidgets`)
|
|
- Please report bugs at https://trac.wxwidgets.org/newticket
|
|
|
|
We would also gladly welcome [your contributions](.github/CONTRIBUTING.md).
|
|
|
|
|
|
Have fun!
|
|
|
|
The wxWidgets Team.
|