Skip to content

Commit ebba409

Browse files
Initial commit (README.md)
0 parents  commit ebba409

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# SDL3-for-Pascal
2+
3+
Unit files for building
4+
[Free Pascal](https://freepascal.org/) / [Delphi](https://www.embarcadero.com/products/delphi) applications
5+
using the [SDL3 library](https://libsdl.org).
6+
7+
## Installation
8+
9+
(nothing to install atm.)
10+
11+
## Documentation
12+
13+
(needs implementation)
14+
15+
## Bugs / Contributions / ToDos
16+
17+
If you have any contributions or bugfixes, feel free to drop a pull request or send in a patch.
18+
Please use the GitHub [issue tracker](https://github.com/PascalGameDevelopment/SDL3-for-Pascal/issues).
19+
20+
### ToDos
21+
22+
- create working units (main focus)
23+
- adapt comments to [PasDoc format](https://pasdoc.github.io) (later)
24+
25+
### Code style guidelines
26+
27+
The main principle is to stay as tight as possible at the names in the C headers.
28+
These guidelines aim to have better consistency in this community project and make
29+
it easier to find certain code parts in the C headers/Pascal includes. Feel free
30+
to discuss or extend these guidelines, use the issue tracker.
31+
32+
For details please refer to our [Translation Code Style Sheet](STYLESHEET.md).
33+
34+
## Versions
35+
36+
The version number/tag (see [tags](https://github.com/PascalGameDevelopment/SDL3-for-Pascal/tags)) refers to the version of this unit package [SDL3 for Pascal](https://github.com/PascalGameDevelopment/SDL3-for-Pascal), not the `SDL3 Library`.
37+
38+
### v0.x (work in progress)
39+
40+
- first release of working units (version number will reflect progress and stability of first release)
41+
42+
## License
43+
44+
The units are licensed under the [zlib license](https://opensource.org/license/zlib).

0 commit comments

Comments
 (0)