From 02f9484d250a3698c0b52a7127cac3831f3c4f6b Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Tue, 2 Jan 2018 17:06:19 +0100 Subject: [PATCH] WIP:readme --- README.md | 58 ++++++++----------------------------------------------- 1 file changed, 8 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 8398169..118b36f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.--> -This is a lightweight, easy to use, fast and simple [Entity-Component-System](https://en.wikipedia.org/wiki/Entity–component–system) implementation for Swift. It is developed and maintained as part of the Fireblade Game Engine project. +This is a **dependency free**, **lightweight**, **fast** and **easy to use** [Entity-Component-System](https://en.wikipedia.org/wiki/Entity–component–system) implementation in Swift. It is developed and maintained as part of the Fireblade Game Engine project. ## Getting Started @@ -40,69 +40,27 @@ let package = Package( ``` -### Contribution - -Clone this repository into your favorite folder. -If you like to edit the project via Xcode use the following to generate the Xcode Project. - -``` -cd -swift package generate-xcodeproj -open FirebladeECS.xcodeproj -``` - - End with an example of getting some data out of the system or using it for a little demo ## Code Example -Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise. + + ## Versioning -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ctreffs/fireblade-ecs/tags). ## Authors -* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) +* [Christian Treffs](https://github.com/ctreffs) - *Initial work* +* [Manuel Weidmann](https://github.com/vyo) -See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. +See also the list of [contributors](https://github.com/ctreffs/fireblade-ecs/project/contributors) who participated in this project. ## License