TheCloud/libSDL2pp
1
0
Fork 0
mirror of https://github.com/libSDL2pp/libSDL2pp.git synced 2025-08-03 19:05:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Dmitry Marakasov 2022-04-27 21:35:52 +03:00
parent e2b68b19cd
commit 1aa7dae69d
1 changed files with 16 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,14 +1,14 @@
# libSDL2pp #
<a href="https://repology.org/metapackage/libsdl2pp/versions">
<img src="https://repology.org/badge/vertical-allrepos/libsdl2pp.svg" alt="libsdl2pp packaging status" align="right">
</a>
[![Build Status](https://travis-ci.org/libSDL2pp/libSDL2pp.svg?branch=master)](https://travis-ci.org/libSDL2pp/libSDL2pp)
[![Build status](https://ci.appveyor.com/api/projects/status/qhfpa29qd8bt619t/branch/master?svg=true)](https://ci.appveyor.com/project/AMDmi3/libsdl2pp)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/3980/badge.svg)](https://scan.coverity.com/projects/3980)
[![Coverage Status](https://coveralls.io/repos/github/libSDL2pp/libSDL2pp/badge.svg?branch=master)](https://coveralls.io/github/libSDL2pp/libSDL2pp?branch=master)
[![Packaging status](https://repology.org/badge/tiny-repos/libsdl2pp.svg)](https://repology.org/metapackage/libsdl2pp)
[![CI](https://github.com/libSDL2pp/libSDL2pp/actions/workflows/ci.yml/badge.svg)](https://github.com/libSDL2pp/libSDL2pp/actions/workflows/ci.yml)
# libSDL2pp
This library provides C++11 bindings/wrapper for SDL2 and satellite libraries.
## Synopsis ##
## Synopsis
```cpp
try {
@ -83,7 +83,7 @@ try {
There's also more elaborate [tutorial](https://github.com/libSDL2pp/libSDL2pp-tutorial).
## Features ##
## Features
Currently, the library provides wrapper classes for
@ -135,7 +135,7 @@ Set of functional extensions above SDL2 is also available:
(for which SDL2 usually uses NULL pointers)
* Number of additional methods and operator support for Point and Rect
## Building ##
## Building
To build libSDL2pp, you need a compiler with C++11 support, for
example clang 3.4+ or gcc 4.8+.
@ -163,7 +163,7 @@ Following variables may be supplied to CMake to affect build:
* ```SDL2PP_STATIC``` - build static library instead of shared (only for standalone build, default OFF)
* ```SDL2PP_ENABLE_LIVE_TESTS``` - enable tests which require X11 and/or audio device to run (only for standalone build, default ON)
## Installation ##
## Installation
To install the library system-wide, run:
@ -187,16 +187,6 @@ INCLUDE_DIRECTORIES(${SDL2PP_INCLUDE_DIRS})
TARGET_LINK_LIBRARIES(... ${SDL2PP_LIBRARIES})
```
SDL2pp is also already available from the following package
repositories:
<a href="https://repology.org/metapackage/libsdl2pp"><img src="https://repology.org/badge/vertical-allrepos/libsdl2pp.svg" alt="Packaging status" align="right"></a>
* [Arch Linux AUR](https://aur.archlinux.org/packages/sdl2pp-git/)
* [DragonflyBSD DPorts](https://github.com/DragonFlyBSD/DPorts/tree/master/devel/sdl2pp)
* [FreeBSD ports](http://www.freshports.org/devel/sdl2pp/)
* [Yet Another Cygwin Ports](https://github.com/fd00/yacp/tree/master/libSDL2pp)
## Bundling ##
The library is easy to integrate into other CMake projects
@ -229,7 +219,7 @@ If bundled, libSDL2pp does not build examples and becomes a static
library, providing required SDL2 includes/libs in the mentioned
variables.
## Completeness ##
## Completeness
The library still doesn't cover all aspects of SDL2, and the development
is generally guided by the author's needs and interest without a goal
@ -245,7 +235,7 @@ SDL2pp::Delay() as it won't bring any convenience over SDL_Delay().
The same strongly applies to the SDL2 bits which duplicate C++11
standard library, e.g. threads and atomic ops.
## Users ##
## Users
Projects using libSDL2pp:
@ -257,16 +247,16 @@ Projects using libSDL2pp:
* [osmview](https://bitbucket.org/ipopov/osmview) - Desktop OpenStreetMap viewer
* [planetonomy](https://github.com/AMDmi3/planetonomy) - Old-school platformer/exploration game with CGA graphics
## WWW ##
## WWW
* [GitHub page](https://github.com/libSDL2pp/libSDL2pp)
* [Online documentation](https://sdl2pp.amdmi3.ru/)
## Author ##
## Author
* [Dmitry Marakasov](https://github.com/AMDmi3) <amdmi3@amdmi3.ru>
## Contributors ##
## Contributors
* [Aargonian](https://github.com/Aargonian)
* [Carl Schwope](https://github.com/Lowest0ne)
@ -277,6 +267,6 @@ Projects using libSDL2pp:
* [Vladimir Gamalian](https://github.com/vladimirgamalian)
* [Vraiment](https://github.com/Vraiment)
## License ##
## License
libSDL2pp comes under zlib license, the same license as SDL2. See COPYING.txt.