diff --git a/README.md b/README.md index 50be58f..bebb99c 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Systems in tiny-ecs describe how to update Entities. Systems select certain Enti using a Filter, and then only update those select Entities. Some Systems don't update Entities, and instead just act as function callbacks every update. Tiny-ecs provides functions for creating Systems easily, as well as creating Systems that -can be used in an object orientented fashion. +can be used in an object oriented fashion. ### Filters ### Filters are used to select Entities. Filters can be any lua function, but @@ -66,7 +66,7 @@ end ## Use It ## Copy paste tiny.lua into your source folder. For stability and consistent API, please use a tagged release or use luarocks. Tagged releases will have a version -number in `tiny._VERSION`, while other commits will just have the string 'dev'. +number in `tiny._VERSION`, while other commits will just have the string 'scm'. ## Luarocks ## Tiny-ecs is also on [Luarocks](https://luarocks.org/) and can be installed with @@ -85,10 +85,3 @@ Tiny-ecs uses [busted](http://olivinelabs.com/busted/) for testing. Install and See API [here](http://bakpakin.github.io/tiny-ecs/doc/). For the most up-to-date documentation, read the source code, or generate the HTML locally with [LDoc](http://stevedonovan.github.io/ldoc/). - -## TODO ## - -* More testing -* Performance testing / optimization -* Add more System types -* Improve Documentation diff --git a/tiny-ecs-scm.rockspec b/tiny-ecs-scm.rockspec new file mode 100644 index 0000000..b70a896 --- /dev/null +++ b/tiny-ecs-scm.rockspec @@ -0,0 +1,23 @@ +package = "tiny-ecs" +version = "scm" +source = { + url = "git://github.com/bakpakin/tiny-ecs", +} +description = { + summary = "Entity Component System for Lua.", + detailed = [[ + Pure Lua implementation of an easy to use, compact, fast, and flexible + Entity Component System. Works well with Object Orientation. + ]], + homepage = "https://github.com/bakpakin/tiny-ecs", + license = "MIT" +} +dependencies = { + "lua >= 5.1" +} +build = { + type = "builtin", + modules = { + tiny = "tiny.lua" + } +} diff --git a/tiny.lua b/tiny.lua index b4dc807..eaed597 100644 --- a/tiny.lua +++ b/tiny.lua @@ -23,7 +23,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -- @author Calvin Rose -- @license MIT -- @copyright 2015 -local tiny = { _VERSION = "1.1-2" } +local tiny = { _VERSION = "scm" } -- Local versions of standard lua functions local tinsert = table.insert