diff --git a/README.md b/README.md index 2183f55..c2948fb 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,20 @@ В папке [Библиотека](./Библиотека/) сама библиотека. В папке [GreatGamedevVault](./GreatGamedevVault/) документация со ссылками на скрипты и плагины и указанием автора в формате хранилища для [Obsidian.md](https://obsidian.md) + +## Инструкция как это трогать + +1. Склонировать этот репозиторий или скачать архив (лучше клонировать) +2. Открыть папку [GreatGamedevVault](./GreatGamedevVault/) как хранилище в [Obsidian](https://obsidian.md) +3. Дока для модулей будет в хранилище + +Далее опционально + +4. Если склонировал репозиторий, то можно создать свою ветку и вносить изменения в документацию: + 1. Создать ветку; + 2. Добавить изменения и зафиксировать их; + 3. Запушить ветку в этот репозиторий; + 4. Если есть доступ, то создать тут запрос на слияние; + 5. ... + 6. Profit! +5. При клонировании репозитория по такой же схеме можно добавлять файлы \ No newline at end of file