chore: add README

Author: yyc-git

ECS模式代码/ecs_pattern_role_abstract/README.md

@@ -0,0 +1,3 @@
+# 如何运行代码
+
+不能运行

ECS模式代码/story_after/README.md

@@ -1,12 +1,17 @@
+# 如何运行代码
 
-这里与之前一样，我们将一个GameObject的数据保存在一个state中，然后用一个索引与其关联。具体就是：
-gameObject其实就是一个number类型的id值，
-gameObjectState保存了一个GameObject的数据
-gameObject与gameObjectState一一关联，这个关联体现在前者是WorldState->gameObjects这个Hash Map的Key，后者是它的Value
+```js
+npm run client
+```
 
-<!-- World封装了操作GameObject和组件的API -->
+# 代码说明
 
+跟之前一样，我们将一个GameObject的数据保存在一个state中，然后用一个索引与其关联。具体就是：
 
+- gameObject其实就是一个number类型的id值
+- gameObjectState保存了一个GameObject的数据
+- gameObject与gameObjectState一一关联，这个关联体现在前者是WorldState->gameObjects这个Hash Map的Key，后者是它的Value
 
+<!-- World封装了操作GameObject和组件的API -->
 
 组件与GameObject一样，我们将它的数据保存在一个state中，只是不需要索引。所以一个组件就等于一个组件state

ECS模式代码/story_before/README.md

@@ -1,6 +1,15 @@
-我们将一个英雄的数据保存在一个state中，然后用一个索引与其关联。具体就是：
-normalHero、superHero其实就是一个number类型的id值
-normalHeroState、superHeroState分别保存了一个普通英雄、一个超级英雄的数据（比如position、velocity）
-normalHero与normalHeroState一一关联，这个关联体现在前者是WorldState->normalHeroes这个Hash Map的Key，后者是它的Value
-同理，superHero与superHeroState关联 
+# 如何运行代码
+
+```js
+npm run client
+```
+
+# 代码说明
+
+我们将一个英雄的数据保存在一个state中，然后用一个索引与其关联。具体就是：  
+
+- normalHero、superHero其实就是一个number类型的id值
+- normalHeroState、superHeroState分别保存了一个普通英雄、一个超级英雄的数据（比如position、velocity）
+- normalHero与normalHeroState一一关联，这个关联体现在前者是WorldState->normalHeroes这个Hash Map的Key，后者是它的Value
+- 同理，superHero与superHeroState关联 
 

ECS模式代码/story_improve/README.md

@@ -1,13 +1,13 @@
+# 如何运行代码
 
-值得注意的是：
-将“gameObject挂载了哪些组件”的数据放在哪里？
-它们可以放在GameObjectManager中，也可以分散地放在各个组件的Manager中。
-考虑到为了方便组件直接就近获得GameObject挂载的其它组件，所以我们选择后者
-组件的Manager可以通过“挂载的gameObject”、“gameObject挂载了哪些组件”这两个数据来获得GameObject挂载的其它组件
+```js
+npm run client
+```
 
+# 代码说明
 
 
+值得注意的是：  
 
-TODO remove?
-值得注意的是：
-因为“gameObject挂载了哪些组件”的数据（如这里的gameObjectPositionMap）是放在组件的Manager（如这里的PositionComponentManager）中的，所以挂载组件的代码也放在组件的Manager（如这里的PositionComponentManager）而不是GameObjectManager中
+- 将“gameObject挂载了哪些组件”的数据放在哪里？它们可以放在GameObjectManager中，也可以分散地放在各个组件的Manager中。考虑到为了方便组件直接就近获得GameObject挂载的其它组件，所以我们选择后者。组件的Manager可以通过“挂载的gameObject”、“gameObject挂载了哪些组件”这两个数据来获得GameObject挂载的其它组件
+- 因为“gameObject挂载了哪些组件”的数据（如gameObjectPositionMap）是放在组件的Manager（如PositionComponentManager）中的，所以操作“GameObject和挂载的组件”的代码也放在组件的Manager（如PositionComponentManager）而不是GameObjectManager中

README.md

@@ -0,0 +1,35 @@
+# 《3D编程模式》
+
+本书是开源书，罗列了我从自己的实战项目中提炼出来的关于3D编程（主要包括“3D引擎/游戏引擎”、“编辑器”开发）的各种编程模式
+
+本书作者：杨元超
+
+**[在线阅读](TODO)**
+
+
+## 源码索引
+
+要想运行源码，请在Clone本仓库后，先在仓库根目录执行下面的命令：
+```js
+npm install
+npm run bootstrap
+```
+安装了yarn的同学可以执行下面的命令来替代上面的命令：
+```js
+yarn
+yarn bootstrap
+```
+
+
+下面是各个模式的源码索引：
+
+- ECS模式源码
+    - [普通英雄和超级英雄](./ECS模式代码/story_before/README.md)
+    - [基于组件化的思想改进](./ECS模式代码/story_after/README.md)
+    - [使用ECS模式来改进](./ECS模式代码/story_improve/README.md)
+    - [抽象代码](./ECS模式代码/ecs_pattern_role_abstract/README.md)
+
+
+## 版权许可
+
+本书采用“保持署名”创意共享 4.0 许可证。只要保持原作者署名，您可以自由地阅读、分享、修改本书。