len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-09-02 20:33:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Small fixes

Browse source
This commit is contained in:
Justin van der Leij 2018-11-26 12:37:28 +01:00
parent f7a394f057
commit 6ddb28ffbc
10 changed files with 85 additions and 71 deletions
Download patch file Download diff file Expand all files Collapse all files

78
README.md
View file

@ -1,39 +1,39 @@
# Concord
Concord is a feature complete ECS.
It's main focus is on speed and usage. You should be able to quickly write code that performs well.
Documentation for Concord can be found in the [Wiki tab](https://github.com/Tjakka5/Concord/wiki).
Auto generated docs for Concord can be found in the [Github page](https://tjakka5.github.io/Concord/). These are still work in progress and might be incomplete though.
## Installation
Download the repository and drop it in your project, then simply require it as:
```lua
local Concord = require(PathToConcord).init()
You will only need to call .init once when you first require it.
```
## Modules
Below is a list of modules.
More information about what each done can be found in the Wiki
```lua
local Concord = require("concord")
local Entity = require("concord.entity")
local Component = require("concord.component")
local System = require("concord.system")
local Instance = require("concord.instance")
```
## Contributors
```
Positive07: Constant support and a good rubberduck
Brbl: Early testing and issue reporting
Josh: Squashed a few bugs and docs
Erasio: Took inspiration from HooECS. Also introduced me to ECS.
```
## Licence
MIT Licensed - Copyright Justin van der Leij (Tjakka5)
# Concord
Concord is a feature complete ECS.
It's main focus is on speed and usage. You should be able to quickly write code that performs well.
Documentation for Concord can be found in the [Wiki tab](https://github.com/Tjakka5/Concord/wiki).
Auto generated docs for Concord can be found in the [Github page](https://tjakka5.github.io/Concord/). These are still work in progress and might be incomplete though.
## Installation
Download the repository and drop it in your project, then simply require it as:
```lua
local Concord = require(PathToConcord).init()
You will only need to call .init once when you first require it.
```
## Modules
Below is a list of modules.
More information about what each done can be found in the Wiki
```lua
local Concord = require("concord")
local Entity = require("concord.entity")
local Component = require("concord.component")
local System = require("concord.system")
local Instance = require("concord.instance")
```
## Contributors
```
Positive07: Constant support and a good rubberduck
Brbl: Early testing and issue reporting
Josh: Squashed a few bugs and docs
Erasio: Took inspiration from HooECS. Also introduced me to ECS.
```
## Licence
MIT Licensed - Copyright Justin van der Leij (Tjakka5)