From f4a70413878936094358145cf9daf8cd0c35d2ad Mon Sep 17 00:00:00 2001 From: Lars Mueller Date: Fri, 9 Sep 2022 14:49:15 +0200 Subject: [PATCH] Add principles to Readme --- Readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Readme.md b/Readme.md index fc5897c..69f6938 100644 --- a/Readme.md +++ b/Readme.md @@ -6,6 +6,15 @@ Multipurpose Minetest Modding Library No dependencies. Licensed under the MIT License. Written by Lars Mueller aka LMD or appguru(eu). Notable contributions by [luk3yx](https://github.com/luk3yx) in the form of suggestions, bug reports and fixes. Another [bugfix](https://github.com/appgurueu/modlib/pull/7) by [NobWow](https://github.com/NobWow/). +### Principles + +* Game-agnostic: Modlib aims to provide nothing game-specific; +* Minimal invasiveness: Modlib should not disrupt other mods; + even at the expense of syntactic sugar, changes to the global + environment - apart from the addition of the modlib scope - are forbidden +* Architecture: Modlib is organized hierarchically +* Performance: Modlib tries to not compromise performance for convenience; modlib loads lazily + ## Tests The tests are located in a different repo, [`modlib_test`](https://github.com/appgurueu/modlib_test), as they are quite heavy due to testing the PNG reader using PngSuite. Reading the tests for examples of API usage is recommended.