1
0
Fork 0
mirror of https://github.com/Reuh/ubiquitousse.git synced 2025-10-27 09:09:30 +00:00

Add READMEs

This commit is contained in:
Étienne Fildadut 2021-12-25 17:16:40 +01:00
parent 6684bb5538
commit d29c839d04
4 changed files with 22 additions and 1 deletions

View file

@ -2,7 +2,7 @@
Set of various libraries I use for game development, mainly with LÖVE. Nothing that hasn't been done before, but these are tailored to what I need. They can be used independently too.
Documentation is done in LDoc-like comments in source files, but LDoc doesn't really like how I structure my libraries so you can't really generate documentation with it. I'm currently trying to fix this; some modules already have a working LDoc documentation in `doc/`.
Documentation is done in LDoc-like comments in source files, but LDoc doesn't really like how I structure my libraries so you can't really generate documentation with it. I'm currently trying to fix this; some modules already have a working LDoc documentation that you can read [here](https://reuh.github.io/ubiquitousse/index.html) or in the `docs/` directory.
Whatever is currently on the master branch should be working and usable. Changelog, including breaking changes, are documented in commit messages.

7
asset/README.md Normal file
View file

@ -0,0 +1,7 @@
# ubiquitousse.asset
Asset manager library.
You can read the documentation [here](https://reuh.github.io/ubiquitousse/modules/asset.html).
Licensed under ISC (equivalent to MIT/Expat/Simplified BSD).

7
ecs/README.md Normal file
View file

@ -0,0 +1,7 @@
# ubiquitousse.ecs
ECS (entity compenent system) library.
You can read the documentation [here](https://reuh.github.io/ubiquitousse/modules/ecs.html).
Licensed under ISC (equivalent to MIT/Expat/Simplified BSD).

7
ldtk/README.md Normal file
View file

@ -0,0 +1,7 @@
# ubiquitousse.ldtk
[LDtk](https://ldtk.io/) level importer for LÖVE.
You can read the documentation [here](https://reuh.github.io/ubiquitousse/modules/ldtk.html).
Licensed under ISC (equivalent to MIT/Expat/Simplified BSD).