Skip to content

Commit 656f71e

Browse files
Update
1 parent d8f7f2d commit 656f71e

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,21 @@ using the [SDL3 library](https://libsdl.org).
66

77
## Installation
88

9-
(nothing to install atm.)
9+
Simply add the units to your include path. You can achieve this by:
10+
- (FPC) using the `{$UNITPATH XXX}` directive in your source code;
11+
- (FPC) using the `-FuXXX` command-line argument to the compiler;
12+
- just copying & pasting the units into the same directory as your main source code.
13+
14+
Use the `SDL3` unit for the main SDL3 library (should be always needed). Units for the other SDL3 libraries are (or will be) also provided:
15+
- [`SDL3_image`](https://github.com/libsdl-org/SDL_image)
16+
- [`SDL3_ttf`](https://github.com/libsdl-org/SDL_ttf) (pending, PR #19)
17+
- [`SDL3_mixer`](https://github.com/libsdl-org/SDL_mixer) (not published yet)
18+
- [`SDL3_net`](https://github.com/libsdl-org/SDL_net) (not published yet)
19+
- [`SDL3_gfx`](https://github.com/sabdul-khabir/SDL3_gfx) (todo)
1020

1121
## Documentation
1222

13-
(needs implementation)
23+
- ToDo: Implement GitHub Pages
1424

1525
## Bugs / Contributions / ToDos
1626

@@ -19,7 +29,9 @@ Please use the GitHub [issue tracker](https://github.com/PascalGameDevelopment/S
1929

2030
### ToDos
2131

22-
- create working units (main focus)
32+
- implement GitHub Pages documentation via GitHub Actions
33+
- implement GitHub Actions CI for testing + adapt tests ([FPCUnit](https://wiki.freepascal.org/fpcunit)?)
34+
- improve units (search for "#todo" to find specific tasks)
2335
- adapt comments to [PasDoc format](https://pasdoc.github.io) (later)
2436

2537
### Code style guidelines

0 commit comments

Comments
 (0)