Documentation work

This commit is contained in:
Camilla Berglund 2016-07-14 18:02:44 +02:00
parent 30111efc6d
commit 868f248696
2 changed files with 54 additions and 14 deletions

View File

@ -264,10 +264,12 @@ planning to write code for the feature, see the section below.
## Contributing a bug fix ## Contributing a bug fix
__Note:__ You _must_ mention if you have taken any code from outside sources, __Note:__ You must have all necessary rights to any code you contribute. If you
even if the licenses seem compatible. did not write the code yourself, you must explain where it came from and under
what license. Even code using the same license as GLFW may not be copied
without attribution.
There is no preferred patch size. A one character fix is very welcome, as is __There is no preferred patch size__. A one character fix is just as welcome as
a thousand line one, if that is the appropriate size for the fix. a thousand line one, if that is the appropriate size for the fix.
In addition to the code, a complete bug fix includes: In addition to the code, a complete bug fix includes:
@ -275,14 +277,24 @@ In addition to the code, a complete bug fix includes:
- Change log entry in `README.md`, describing the incorrect behavior - Change log entry in `README.md`, describing the incorrect behavior
- Credits entries for all authors of the bug fix - Credits entries for all authors of the bug fix
Bug fixes will not be rejected because they don't include all the above parts,
but please keep in mind that maintainer time is finite and that there are many
other bugs and features to work on.
If the patch fixes a bug introduced after the last release, it should not get If the patch fixes a bug introduced after the last release, it should not get
a change log entry. a change log entry.
## Contributing a feature ## Contributing a feature
__Note:__ You _must_ mention if you have taken any code from outside sources, __Note:__ You must have all necessary rights to any code you contribute. If you
even if the licenses seem compatible. did not write the code yourself, you must explain where it came from and under
what license. Even code using the same license as GLFW may not be copied
without attribution.
__There is no preferred patch size__. A one character change is just as welcome
as one adding a thousand line one, if that is the appropriate size for the
feature.
In addition to the code, a complete feature includes: In addition to the code, a complete feature includes:
@ -293,18 +305,24 @@ In addition to the code, a complete feature includes:
- Cross-references and mentions in appropriate places - Cross-references and mentions in appropriate places
- Credits entries for all authors of the feature - Credits entries for all authors of the feature
If it requires platform-specific code, add at minimum stubs for the new platform If the feature requires platform-specific code, at minimum stubs must be added
function to all supported platforms. for the new platform function to all supported and experimental platforms.
If it adds a new callback, add support for it in `tests/event.c`. If it adds a new callback, support for it must be added to `tests/event.c`.
If it adds a new monitor property, add support for it in `tests/monitor.c`. If it adds a new monitor property, support for it must be added to
`tests/monitor.c`.
If it adds a new OpenGL, OpenGL ES or Vulkan option or extension, add support If it adds a new OpenGL, OpenGL ES or Vulkan option or extension, support
for it in `tests/glfwinfo.c` and describe its use in `docs/compat.dox`. for it must be added to `tests/glfwinfo.c` and the behavior of the library when
the extension is missing documented in `docs/compat.dox`.
Please keep in mind that any part of the public API that has been included in Features will not be rejected because they don't include all the above parts,
a release cannot be changed until the next _major_ version. Features can be but please keep in mind that maintainer time is finite and that there are many
other features and bugs to work on.
Please also keep in mind that any part of the public API that has been included
in a release cannot be changed until the next _major_ version. Features can be
added and existing parts can sometimes be overloaded (in the general sense of added and existing parts can sometimes be overloaded (in the general sense of
doing more things, not in the C++ sense), but code written to the API of one doing more things, not in the C++ sense), but code written to the API of one
minor release should both compile and run on subsequent minor releases. minor release should both compile and run on subsequent minor releases.

View File

@ -37,6 +37,28 @@ See the
guide in the GLFW documentation. guide in the GLFW documentation.
## Compile-time requirements
GLFW supports compilation on Visual C++ 2010 and later, MinGW and MinGW-w64,
Clang on OS X and GCC and Clang on Linux and other Unix-like systems. It will
likely compile in other environments as well, but this is not regularly tested.
See the [compilation guide](http://www.glfw.org/docs/latest/compile.html) for
more information.
## Run-time requirements
GLFW supports Windows XP and later, OS X 10.7 Lion and later, and Linux and
other Unix-like systems with the X Window System.
Experimental implementations for the Wayland protocol and the Mir display
server are available but not yet officially supported.
See the [compatibility guide](http://www.glfw.org/docs/latest/compat.html)
for more information.
## Reporting bugs ## Reporting bugs
Bugs are reported to our [issue tracker](https://github.com/glfw/glfw/issues). Bugs are reported to our [issue tracker](https://github.com/glfw/glfw/issues).
@ -75,7 +97,7 @@ does not find Doxygen, the documentation will not be generated.
- Bugfix: Single compilation unit builds failed due to naming conflicts (#783) - Bugfix: Single compilation unit builds failed due to naming conflicts (#783)
- Bugfix: The range checks for `glfwSetCursorPos` used the wrong minimum (#773) - Bugfix: The range checks for `glfwSetCursorPos` used the wrong minimum (#773)
- [Win32] Bugfix: `glfwSetClipboardString` created an unneccessary intermediate - [Win32] Bugfix: `glfwSetClipboardString` created an unnecessary intermediate
copy of the string copy of the string
- [Win32] Bugfix: Examples failed to build on Visual C++ 2010 due to C99 in - [Win32] Bugfix: Examples failed to build on Visual C++ 2010 due to C99 in
`linmath.h` (#785) `linmath.h` (#785)