From 1e34dc2acdf5246c2ed4f0394a84c897718e5eb9 Mon Sep 17 00:00:00 2001
From: Mikhail <99481254+DCFApixels@users.noreply.github.com>
Date: Thu, 25 May 2023 17:40:19 +0800
Subject: [PATCH] Update README.md
---
README.md | 17 ++++++++++++++---
1 file changed, 14 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 269ce66..ce4a13d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,3 @@
-
@@ -8,17 +7,29 @@
> **ВАЖНО!** Проект в стадии разработки. API может меняться. README так же не завершен.
## Оглавление
+* [Установка](#Установка)
+ * [Unity-модуль](#Unity-модуль)
+ * [В виде иходников](#В-виде-иходников)
* [Основные концепции](#Основные-концепции)
* [Сущность](#Сущность)
* [Компонент](#Компонент)
* [Система](#Система)
* [Pipeline](#Pipeline)
- * [Процесс/Раннер](#Процесс-Раннер)
+ * [Процесс и Раннер](#Процесс-и-Раннер)
* [Группа](#Группа)
* [Субъект](#Субъект)
* [Запрос](#Запрос)
* [Расширения](#Расширения)
+# Установка
+* ### Unity-модуль
+Поддерживается установка в виде Unity-модуля в при помощи добавления git-URL [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или редактирования `Packages/manifest.json`:
+```
+https://github.com/DCFApixels/DragonECS.git
+```
+* ### В виде иходников
+Фреймворк так же может быть добавлен в проект в виде исходников.
+
# Основные концепции
## Сущность
Сущности - это идентификаторы, к которым крепятся данные. Есть 2 типа идентификатора:
@@ -64,7 +75,7 @@ class UserSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDest
## Pipeline
Является двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы.
-## Процесс/Раннер
+## Процесс и Раннер
Процессы - это очереди систем реализующие общий интерфейс. Раннеры запускюат выполнение процессов. Система раннеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner().
> Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры.