File tree Expand file tree Collapse file tree 1 file changed +15
-3
lines changed Expand file tree Collapse file tree 1 file changed +15
-3
lines changed Original file line number Diff line number Diff line change @@ -6,11 +6,21 @@ using the [SDL3 library](https://libsdl.org).
6
6
7
7
## Installation
8
8
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)
10
20
11
21
## Documentation
12
22
13
- (needs implementation)
23
+ - ToDo: Implement GitHub Pages
14
24
15
25
## Bugs / Contributions / ToDos
16
26
@@ -19,7 +29,9 @@ Please use the GitHub [issue tracker](https://github.com/PascalGameDevelopment/S
19
29
20
30
### ToDos
21
31
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)
23
35
- adapt comments to [ PasDoc format] ( https://pasdoc.github.io ) (later)
24
36
25
37
### Code style guidelines
You can’t perform that action at this time.
0 commit comments