Skip to content

Commit

Permalink
fix: tidy up doxygen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alegemaate committed Sep 21, 2023
1 parent 7a14bbb commit 25dc17b
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 20 deletions.
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
# asw

A.D.S. Games SDL Wrapper
A.D.S. Games SDL Wrapper.

## Usage (CMAKE)

### Add submodule
This project started as a way to easily port allegro4 games to SDL2. Now it intends to make it easier to use SDL2 in C++. A primary focus is to allow easy compilation of games using emscripten as well, and has been throughly tested with it.

```
mkdir lib
git submodule add https://github.com/AdsGames/asw lib/asw
```

### Add to CMakeLists.txt
## Usage (CMAKE)

```
set(ASW_HEADERS lib/asw)
### Fetch Content

target_include_directories(
executable_name PRIVATE
${ASW_HEADERS}
```sh
FetchContent_Declare(
asw
GIT_REPOSITORY https://github.com/adsgames/asw.git
GIT_TAG <tag from latest version>
)
FetchContent_MakeAvailable(asw)
```
1 change: 0 additions & 1 deletion include/asw/modules/assets.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
* @copyright Copyright (c) 2023
*
*/

#ifndef ASW_ASSETS_H
#define ASW_ASSETS_H

Expand Down
1 change: 0 additions & 1 deletion include/asw/modules/core.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
* @copyright Copyright (c) 2023
*
*/

#ifndef ASW_CORE_H
#define ASW_CORE_H

Expand Down
6 changes: 3 additions & 3 deletions include/asw/modules/types.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
#ifndef ASW_TYPES_H
#define ASW_TYPES_H

/**
* @file types.h
* @author Allan Legemaate (alegemaate@gmail.com)
Expand All @@ -10,6 +7,9 @@
* @copyright Copyright (c) 2023
*
*/
#ifndef ASW_TYPES_H
#define ASW_TYPES_H

#include <SDL2/SDL.h>
#include <SDL2/SDL_mixer.h>
#include <SDL2/SDL_ttf.h>
Expand Down

0 comments on commit 25dc17b

Please sign in to comment.