From d29c839d04dab262b54a1a3d399bad67852a390f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Reuh=20Fildadut?= Date: Sat, 25 Dec 2021 17:16:40 +0100 Subject: [PATCH] Add READMEs --- README.md | 2 +- asset/README.md | 7 +++++++ ecs/README.md | 7 +++++++ ldtk/README.md | 7 +++++++ 4 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 asset/README.md create mode 100644 ecs/README.md create mode 100644 ldtk/README.md diff --git a/README.md b/README.md index e4f04d3..f31f933 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/asset/README.md b/asset/README.md new file mode 100644 index 0000000..bfe0f0f --- /dev/null +++ b/asset/README.md @@ -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). diff --git a/ecs/README.md b/ecs/README.md new file mode 100644 index 0000000..da82cb7 --- /dev/null +++ b/ecs/README.md @@ -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). diff --git a/ldtk/README.md b/ldtk/README.md new file mode 100644 index 0000000..f22d20f --- /dev/null +++ b/ldtk/README.md @@ -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).