library-mirrors/tiny-ecs
1
0
Fork 0
mirror of https://github.com/bakpakin/tiny-ecs.git synced 2024-11-17 04:44:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix a few spellings in the README

Browse Source 
Hi! While reading the README I noticed a few things that could be corrected. Here they are. Thanks for the project, it's very interesting!
This commit is contained in:
Oliver Vartiainen 2019-10-12 22:02:37 +03:00 committed by GitHub
parent 65de2a9c6f
commit 36364df4e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -3,9 +3,9 @@
## NOTE ## NOTE
Although there have been almost no commits in several years, this Although there have been almost no commits in several years, this
project is not abandoned. tiny-ecs is for most intents and project is not abandoned. tiny-ecs is, for most intents and
purposes, finished, and no bugs have been brought to my attention in a while. purposes, finished, and no bugs have been brought to my attention in a while.
New issues on Github will be addressed. New issues on GitHub will be addressed.
[![Build Status](https://travis-ci.org/bakpakin/tiny-ecs.png?branch=master)](https://travis-ci.org/bakpakin/tiny-ecs)[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE) [![Build Status](https://travis-ci.org/bakpakin/tiny-ecs.png?branch=master)](https://travis-ci.org/bakpakin/tiny-ecs)[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)
@ -15,11 +15,11 @@ for simulating large and complex systems. For more explanation on Entity
Component Systems, here is some Component Systems, here is some
[basic info](http://en.wikipedia.org/wiki/Entity_component_system "Wikipedia"). [basic info](http://en.wikipedia.org/wiki/Entity_component_system "Wikipedia").
Tiny-ecs also works well with objected oriented programming in Lua because Tiny-ecs also works well with object-oriented programming in Lua because
Systems and Entities do not use metatables. This means you can subclass your Systems and Entities do not use metatables. This means you can subclass your
Systems and Entities, and use existing Lua class frameworks with tiny-ecs, no problem. Systems and Entities and use existing Lua class frameworks with tiny-ecs, no problem.
For an example on how to use tiny-ecs with object-oriented Lua, take a look at the For an example on how to use tiny-ecs with object-oriented Lua, take a look at the
demo branch, specifically the systems and entities sub-directories. demo branch, specifically the systems and entities subdirectories.
## Overview ## ## Overview ##
Tiny-ecs has four important types: Worlds, Filters, Systems, and Entities. Tiny-ecs has four important types: Worlds, Filters, Systems, and Entities.
@ -75,10 +75,10 @@ end
## Use It ## ## Use It ##
Copy paste tiny.lua into your source folder. For stability and consistent API, Copy paste tiny.lua into your source folder. For stability and consistent API,
please use a tagged release or use luarocks. please use a tagged release or use LuaRocks.
## Luarocks ## ## Luarocks ##
Tiny-ecs is also on [Luarocks](https://luarocks.org/) and can be installed with Tiny-ecs is also on [LuaRocks](https://luarocks.org/) and can be installed with
`luarocks install tiny-ecs`. `luarocks install tiny-ecs`.
## Demo ## ## Demo ##