Add: Central README.md
This commit is contained in:
parent
d43499b843
commit
57c7231dc1
26
README.md
Normal file
26
README.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# Barcelli Entity-Component-System (BECS)
|
||||
|
||||
This is an header only library implementing a Entity-Component-System in C89 using memory arenas. You can look at tests/main.c for an example of an implementation. This is an educational library, done in my free time. If you are interested in improving the design of this ECS, feel free to submit a pull request.
|
||||
|
||||
## Instructions on Usage
|
||||
|
||||
Include `becs.h` and in exactly one file define `BECS_IMPLEMENTATION` before the include.
|
||||
|
||||
To setup your Maximum Entity Count and Maximum component count, define `BECS_MAX_ENTITIES` and `BECS_MAX_COMPONENTS` before including `becs.h`
|
||||
|
||||
Example:
|
||||
|
||||
```c
|
||||
#define BECS_MAX_ENTITIES 100
|
||||
#define BECS_MAX_COMPONENTS 10
|
||||
|
||||
#define BECS_IMPLEMENTATION
|
||||
#include <becs.h>
|
||||
|
||||
int main(void)
|
||||
{
|
||||
/* your program goes here */
|
||||
}
|
||||
```
|
||||
|
||||
## Systems
|
||||
Loading…
Reference in a new issue