diff --git a/README.md b/README.md index 1a5904e..eb2bef9 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,39 @@
# Integration with Unity for [DragonECS](https://github.com/DCFApixels/DragonECS) -> **ВАЖНО!** Проект в стадии разработки. API может меняться. + +| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-Unity/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-Unity) | +| :--- | :--- | :--- | + +The extension is designed to reduce the amount of code by simplifying dependency injection by doing injections automatically. +> **NOTICE:** The project is a work in progress, API may change. +> While the English version of the README is incomplete, you can view the [Russian version](https://github.com/DCFApixels/DragonECS-Unity/blob/main/README-RU.md). + + + + +# Installation +Versioning semantics - [Open](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md) +## Environment +Requirements: ++ Dependency: [DragonECS](https://github.com/DCFApixels/DragonECS) ++ Minimum version of C# 7.3; ++ Minimum version of Unity 2021.2.0; + +Tested with: ++ **Unity:** Minimum version 2021.2.0; + +## Unity Installation +* ### Unity Package +The framework can be installed as a Unity package by adding the Git URL [in the PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) or manually adding it to `Packages/manifest.json`: +``` +https://github.com/DCFApixels/DragonECS-Unity.git +``` +* ### Source Code +The framework can also be added to the project as source code. + + diff --git a/README_RU.md b/README_RU.md index 1a5904e..1ba47e1 100644 --- a/README_RU.md +++ b/README_RU.md @@ -5,8 +5,39 @@ -# Integration with Unity for [DragonECS](https://github.com/DCFApixels/DragonECS) +# Интеграция с Unity для [DragonECS](https://github.com/DCFApixels/DragonECS) + +| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-Unity/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-Unity) | +| :--- | :--- | :--- | + +Расширение добавит набор инструментов для дебага и связи с движком Unity. С помощью инструментов отладки можно > **ВАЖНО!** Проект в стадии разработки. API может меняться. +# Оглавление +- [Установка](#установка) + + + +# Установка +Семантика версионирования - [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md) +## Окружение +Обязательные требования: ++ Зависимость: [DragonECS](https://github.com/DCFApixels/DragonECS) ++ Минимальная версия C# 7.3; ++ Минимальная версия Unity 2021.2.0; + +Протестированно: ++ **Unity:** Минимальная версия 2021.2.0; + +## Установка для Unity +* ### 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-Unity.git +``` +* ### В виде иходников +Фреймворк так же может быть добавлен в проект в виде исходников. + +