From 807bef1c4907c03102ae6c1f9907915194e865e9 Mon Sep 17 00:00:00 2001 From: Justin van der Leij Date: Sat, 7 Apr 2018 18:21:42 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 9343d63..a41225e 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ # 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 + +# Installation +Download the repository and drop it in your project, then simply require it as: +```lua +local Concord = require(PathToConcord).init({ + +}) +``` + +# Configuration +Concord has a initialization function which takes a table of boolean parameters: +| Name | Default | Meaning | +| --- | --- | --- | --- | +| useEvents | false | Lets Concord overwrite love.run and automatically propagate events | + +You will only need to call .init once. + +# Modules +Below is a list of modules. +More information about what each done can be found in the Wiki + +``` +local Concord = require("concord") +local Entity = require("concord.entity") +local Component = require("concord.component") +local System = require("concord.system") +local Instance = require("concord.instance") +``` From 57a4f603a03df547c0626e4cc685394d5b321a2b Mon Sep 17 00:00:00 2001 From: Justin van der Leij Date: Sat, 7 Apr 2018 18:22:22 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a41225e..b16cc15 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It's main focus is on speed and usage. You should be able to quickly write code Documentation for Concord can be found in the Wiki tab -# Installation +## Installation Download the repository and drop it in your project, then simply require it as: ```lua local Concord = require(PathToConcord).init({ @@ -13,15 +13,15 @@ local Concord = require(PathToConcord).init({ }) ``` -# Configuration +## Configuration Concord has a initialization function which takes a table of boolean parameters: | Name | Default | Meaning | -| --- | --- | --- | --- | +| --- | --- | --- | | useEvents | false | Lets Concord overwrite love.run and automatically propagate events | You will only need to call .init once. -# Modules +## Modules Below is a list of modules. More information about what each done can be found in the Wiki From fb4dfcf76e0b97c05fe2145ade20a145f356e6a2 Mon Sep 17 00:00:00 2001 From: Justin van der Leij Date: Sat, 7 Apr 2018 18:23:23 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b16cc15..8bf1b8f 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,10 @@ local Concord = require(PathToConcord).init({ ## Configuration Concord has a initialization function which takes a table of boolean parameters: + | Name | Default | Meaning | | --- | --- | --- | -| useEvents | false | Lets Concord overwrite love.run and automatically propagate events | +| useEvents | false | Lets Concord overwrite love.run and automatically propagate events. | You will only need to call .init once. From 637f03b78e4a38f57c59015d42b11999ae94e8d1 Mon Sep 17 00:00:00 2001 From: Justin van der Leij Date: Sat, 7 Apr 2018 18:23:37 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8bf1b8f..31ad491 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ You will only need to call .init once. 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")