mirror of
https://github.com/libSDL2pp/libSDL2pp.git
synced 2025-09-18 03:34:45 -04:00
Merge branch 'readme-vs-doxygen'
This commit is contained in:
commit
78ccebea38
@ -859,7 +859,7 @@ IMAGE_PATH =
|
||||
# code is scanned, but not when the output code is generated. If lines are added
|
||||
# or removed, the anchors will not be placed correctly.
|
||||
|
||||
INPUT_FILTER =
|
||||
INPUT_FILTER = "sed -e '/^\[!\[/d' -e '/^```/,/^```/ s|^| &|' -e '/^ ```/ d'"
|
||||
|
||||
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
||||
# basis. Doxygen will compare the file name with each pattern and apply the
|
||||
@ -868,7 +868,7 @@ INPUT_FILTER =
|
||||
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
|
||||
# patterns match the file name, INPUT_FILTER is applied.
|
||||
|
||||
FILTER_PATTERNS =
|
||||
FILTER_PATTERNS = *.md
|
||||
|
||||
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
||||
# INPUT_FILTER ) will also be used to filter the input files that are used for
|
||||
|
@ -7,6 +7,7 @@ This library provides C++11 bindings/wrapper for SDL2 and satellite libraries.
|
||||
|
||||
## Synopsis ##
|
||||
|
||||
```c++
|
||||
try {
|
||||
using namespace SDL2pp;
|
||||
|
||||
@ -67,6 +68,7 @@ This library provides C++11 bindings/wrapper for SDL2 and satellite libraries.
|
||||
// This also works (e.g. "SDL_Init failed: No available video device")
|
||||
std::cerr << e.what() << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
## Features ##
|
||||
|
||||
@ -165,19 +167,23 @@ still recommended).
|
||||
Just place the library into dedicated directory in your project
|
||||
(for example, extlib/libSDL2pp) and add
|
||||
|
||||
```cmake
|
||||
SET(SDL2PP_WITH_IMAGE ON) # if you need SDL_image support
|
||||
SET(SDL2PP_WITH_TTF ON) # if you need SDL_ttf support
|
||||
ADD_SUBDIRECTORY(extlib/libSDL2pp)
|
||||
```
|
||||
|
||||
into your core CMakeLists.txt. This will act as similar to what
|
||||
FIND_PACKAGE usually does, and will provide ${SDL2PP_INCLUDE_DIRS}
|
||||
and ${SDL2PP_LIBRARIES} variables for your project. You will then
|
||||
be able to use them as usual:
|
||||
|
||||
```cmake
|
||||
INCLUDE_DIRECTORIES(${SDL2PP_INCLUDE_DIRS})
|
||||
|
||||
ADD_EXECUTABLE(mytarget ...)
|
||||
TARGET_LINK_LIBRARIES(mytarget ${SDL2PP_LIBRARIES})
|
||||
```
|
||||
|
||||
if bundled, libSDL2pp does not build examples and becomes a static
|
||||
library, providing required SDL2 includes/libs in the mentioned
|
||||
|
Loading…
x
Reference in New Issue
Block a user