diff options
Diffstat (limited to 'README.mdown')
| -rw-r--r-- | README.mdown | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/README.mdown b/README.mdown index 0463ea8..da80da9 100644 --- a/README.mdown +++ b/README.mdown @@ -5,9 +5,11 @@ [](https://codeclimate.com/github/realtradam/FelFlame/test_coverage) [](https://github.com/realtradam/FelFlame/blob/master/LICENSE) [](https://ko-fi.com/tradam) -<!--[](http://inch-ci.org/github/realtradam/FelECS)--> <!-- this is busted --> +<!--[](http://inch-ci.org/github/realtradam/FelECS)--> <!-- this is busted, probably forever --> -**[Check out the comprehensive documentation here!](https://felecs.tradam.dev)** + +<!-- TODO this needs to be fixed --> +<!-- **[Check out the comprehensive documentation here!](https://felecs.tradam.dev)** --> --- @@ -105,11 +107,24 @@ Order is a helper class which can set the priority of Scenes and Systems. # Usage -There are 2 ways of using FelECS. You can either `include` it as a gem in your project if your game engine supports this. The other option is to download the single file export of FelECS and then `require_relative` this file in your project. The single file export takes all the ruby code in the various files and concatenates them into a single file so it is more portable and easy to add. +There are 3 ways of using FelECS. + +1. You can use it with the [FelFlame Engine](https://github.com/realtradam/FelFlameEngine) +```sh +cd FelFlameEngine/mrbgems +git clone [email protected]:realtradam/FelECS.git +cd FelECS +git checkout mruby-gem +``` -To use the gem method you can do the following: install the gem using `gem install felecs` or using bundler `bundle add felecs` and then require it in your project like so: `require 'felecs'`. +2. You can [include it as a gem](https://rubygems.org/gems/felecs) in your project +```sh +gem install felecs +# or if you use bundler: +bundle add felecs +``` -To use the single file export method you simply download the felecs.rb file from the [releases page on Github](https://github.com/realtradam/FelECS/releases) and add it to your source folder and add a `require relative 'felecs.rb'` line or wherever you have placed the file to use it. +3. You can copy the [single file](https://github.com/realtradam/FelECS/blob/master/mrbgem/mrblib/felecs.rb) into your project and include it manually ## Entities |