From 6fd444feec8bbebebd96e1de71cf162affb2f5a0 Mon Sep 17 00:00:00 2001 From: Booklordofthedings Date: Thu, 21 Nov 2024 16:59:33 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6205cc6..fb1985d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ -# Theater-ECS +### **Theater-ECS** -An ecs to be used in the TE enviroment \ No newline at end of file +is a library which implements the *entity, component, system* pattern. +It is intended to be used for game development in the "Theater Engine" ecosystem, +however it may also be used for other things. + +### Design goals +- Dynamic + *Lots of ECS libraries use compile time code generation for performance benefits. + Theater-ECS is intended to be fully dynamic so that components and system could be created and registered at runtime* +- Fast + *Theater-ECS should be fast enough for most game projects, while handling a high amount of entities and components* +- Use what you need + *The amount of memory used by Theater-ECS is minimized so that it mostly only uses which memory you are actually using and doesnt + allocate any large unused buffers.* + +### Further information +- [Wiki](https://code.booklordofthe.dev/Theater/Theater-ECS/wiki) +- [Example Project](https://code.booklordofthe.dev/Theater/Theater-ECS-Example) \ No newline at end of file From befaf61310aba32b34111a7c649de43e8c50f3cb Mon Sep 17 00:00:00 2001 From: Booklordofthedings Date: Fri, 22 Nov 2024 10:09:22 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index fb1985d..3a06ac5 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ however it may also be used for other things. *The amount of memory used by Theater-ECS is minimized so that it mostly only uses which memory you are actually using and doesnt allocate any large unused buffers.* +### Installation + +No dependencies are required, so you can simply clone this library and add it as a dependency to your +Beef project. +BeefProj.toml: `Dependencies = {Theater-ECS = "*"}` + ### Further information - [Wiki](https://code.booklordofthe.dev/Theater/Theater-ECS/wiki) - [Example Project](https://code.booklordofthe.dev/Theater/Theater-ECS-Example) \ No newline at end of file