瀏覽代碼

review: doc

Michele Caini 7 年之前
父節點
當前提交
af9e6dea68
共有 4 個文件被更改,包括 62 次插入37 次删除
  1. 10 36
      README.md
  2. 2 1
      TODO
  3. 1 0
      docs/CMakeLists.txt
  4. 49 0
      docs/links.md

+ 10 - 36
README.md

@@ -298,50 +298,24 @@ Note that benchmarks are not part of this set.
 
 Consider this list a work in progress and help me to make it longer.
 
+<!--
+@cond TURN_OFF_DOXYGEN
+-->
 # EnTT in Action
 
 `EnTT` is widely used in private and commercial applications. I cannot even
 mention most of them because of some signatures I put on some documents time
-ago.<br/>
-Fortunately, there are also people who took the time to implement open source
-projects based on EnTT and did not hold back when it came to documenting them.
-
-Below an incomplete list of projects and articles:
-
-* [Minecraft](https://minecraft.net/en-us/attribution/): of course, **that**
-  Minecraft, by Mojang (see the open source attributions page).
-* [Face Smash](https://play.google.com/store/apps/details?id=com.gamee.facesmash):
-  the emojis dominate the world, destroy them all with your facial expressions.
-* [shiva](https://github.com/Milerius/shiva): modern C++ Engine with modularity.
-* [EnTT Pacman](https://github.com/Kerndog73/EnTT-Pacman): an example of how to
-  make Pacman with EnTT.
-* [Classic Tower Defence](https://github.com/kerndog73/Classic-Tower-Defence):
-  a tiny little tower defence game featuring a homemade font.
-  [Check it out](https://indi-kernick.itch.io/classic-tower-defence).
-* [The Machine](https://github.com/Kerndog73/The-Machine): a box pushing puzzler
-  with logic gates and other cool stuff.
-  [Check it out](https://indi-kernick.itch.io/the-machine-web-version).
-* [EnttPong](https://github.com/reworks/EnttPong): example game with `EnTT`.
-* [Space Battle: Huge edition](http://victor.madtriangles.com/code%20experiment/2018/06/11/post-ecs-battle-huge.html):
-  huge space battle built entirely from scratch.
-* [Space Battle](https://github.com/vblanco20-1/ECS_SpaceBattle): huge space
-  battle built on `UE4`.
-* [Experimenting with ECS in UE4](http://victor.madtriangles.com/code%20experiment/2018/03/25/post-ue4-ecs-battle.html):
-  interesting article about `UE4` and `EnTT`.
-* [Implementing ECS architecture in UE4](https://forums.unrealengine.com/development-discussion/c-gameplay-programming/1449913-implementing-ecs-architecture-in-ue4-giant-space-battle):
-  giant space battle.
-* [MatchOneEntt](https://github.com/mhaemmerle/MatchOneEntt): port of
-  [Match One](https://github.com/sschmid/Match-One) for `Entitas-CSharp`.
-* [Randballs](https://github.com/gale93/randballs): simple `SFML` and `EnTT`
-  playground.
-* ...
+ago. Fortunately, there are also people who took the time to implement open
+source projects based on `EnTT` and did not hold back when it came to
+documenting them.
+
+[Here](https://github.com/skypjack/entt/wiki/EnTT-in-Action) you can find and
+incomplete list of games, applications and articles that can be used as a
+reference.
 
 If you know of other resources out there that are about `EnTT`, feel free to
 open an issue or a PR and I'll be glad to add them to the list.
 
-<!--
-@cond TURN_OFF_DOXYGEN
--->
 # Contributors
 
 `EnTT` was written initially as a faster alternative to other well known and

+ 2 - 1
TODO

@@ -1,3 +1,4 @@
+* long term feature: templated generic vm
 * long term feature: shared_ptr less locator
 * long term feature: shared_ptr less resource cache
 * custom allocators and EnTT allocator-aware in general (long term feature, I don't actually need it at the moment) - see #22
@@ -19,4 +20,4 @@
 * add a note about multithreading support to the README file
 * signals on entity creation/destruction
 * flexible views with "composable" filters
-* create a dedicated .md for EnTT in Action list and create two sections: articles and games
+* sigh/sink: disconnect doesn't really require the Class type, void * is enough

+ 1 - 0
docs/CMakeLists.txt

@@ -27,6 +27,7 @@ add_custom_target(
         CONTRIBUTING.md
         core.md
         entity.md
+        links.md
         locator.md
         meta.md
         process.md

+ 49 - 0
docs/links.md

@@ -0,0 +1,49 @@
+# EnTT in Action
+
+`EnTT` is widely used in private and commercial applications. I cannot even
+mention most of them because of some signatures I put on some documents time
+ago. Fortunately, there are also people who took the time to implement open
+source projects based on `EnTT` and did not hold back when it came to
+documenting them.
+
+Below an incomplete list of games, applications and articles that can be used as
+a reference:
+
+* Games
+  * [Minecraft](https://minecraft.net/en-us/attribution/): of course, **that**
+    Minecraft, by Mojang (see the open source attributions page).
+  * [Face Smash](https://play.google.com/store/apps/details?id=com.gamee.facesmash):
+    a game to play with your face.
+  * [EnTT Pacman](https://github.com/Kerndog73/EnTT-Pacman): an example of how
+    to make Pacman with `EnTT`.
+  * [Classic Tower Defence](https://github.com/kerndog73/Classic-Tower-Defence):
+    a tiny little tower defence game featuring a homemade font.
+    [Check it out](https://indi-kernick.itch.io/classic-tower-defence).
+  * [The Machine](https://github.com/Kerndog73/The-Machine): a box pushing
+    puzzler with logic gates and other cool stuff.
+    [Check it out](https://indi-kernick.itch.io/the-machine-web-version).
+  * [EnttPong](https://github.com/reworks/EnttPong): an example of how to make
+    Pong with `EnTT`.
+  * [Randballs](https://github.com/gale93/randballs): simple `SFML` and `EnTT`
+    playground.
+
+* Engines:
+  * [shiva](https://github.com/Milerius/shiva): modern C++ engine with
+    modularity.
+
+* Articles
+  * [Space Battle: Huge edition](http://victor.madtriangles.com/code%20experiment/2018/06/11/post-ecs-battle-huge.html):
+    huge space battle built entirely from scratch.
+  * [Space Battle](https://github.com/vblanco20-1/ECS_SpaceBattle): huge space
+    battle built on `UE4`.
+  * [Experimenting with ECS in UE4](http://victor.madtriangles.com/code%20experiment/2018/03/25/post-ue4-ecs-battle.html):
+    interesting article about `UE4` and `EnTT`.
+  * [Implementing ECS architecture in UE4](https://forums.unrealengine.com/development-discussion/c-gameplay-programming/1449913-implementing-ecs-architecture-in-ue4-giant-space-battle):
+    giant space battle.
+
+* Any Other Business:
+  * [MatchOneEntt](https://github.com/mhaemmerle/MatchOneEntt): port of
+    [Match One](https://github.com/sschmid/Match-One) for `Entitas-CSharp`.
+
+If you know of other resources out there that are about `EnTT`, feel free to
+open an issue or a PR and I'll be glad to add them to this page.