diff --git a/readme.md b/readme.md index cbbf964..1b6322e 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,37 @@ -1) создаем папку с модулем -2) копируем и конфигурируем файл .module.json -3) запускаем php -f clone.php ../path_to_new_module \ No newline at end of file +# 🛠️ Инструкция по созданию и настройке модулей + +## 📁 Структура директорий + +```text +└── 📁 local/ + └── 📁 modules/ + ├── 📁 bx.nullable/ + │ └── 📄 clone.php + ├── 📁 comp.dev/ + │ └── 📄 .module.json + └── 📁 wt.core/ +``` + +## 🚀 Пошаговое руководство + +1. **Создайте папку** с вашим новым модулем в директории `local/modules/`. +2. **Скопируйте и настройте** конфигурационный файл `.module.json` внутри созданной папки. +3. **Запустите скрипт клонирования**, выполнив команду в терминале: + ```bash + php -f local/modules/bx.nullable/clone.php ../путь_к_новому_модулю + ``` +## 📄 Пример файла `.module.json` + +Ниже представлен шаблон конфигурации для модуля: + +```json +{ + "id": "comp.dev", + "prefix": "comp_dev", + "namespace": "Comp\\Dev", + "repo": "git@git.ru:bellord/comp.dev.git", + "version": "1.0.0", + "date": "2026-01-01 00:00:00", + "deps": ["wt.core"] +} +``` \ No newline at end of file