add README

README.md

+# Ximper builder
+
+Набор скриптов для сборки образов Ximper Linux с различными окружениями.
+
+## Подготовка
+
+```
+git clone git@gitlab.eterfund.ru:ximperlinux/ximper-builder.git --recursive
+```
+`--recursive` автоматически инициализирует подмодули
+
+## Использование
+
+```
+./bin/build-distro [версия] [опции]
+```
+При сборке вне builde64 используйте `--network`
+### Дополнительные опции
+
+#### Окружения
+`--gnome` - Собрать дистрибутив с GNOME (по умолчанию)
+
+`--hyprland` - Собрать дистрибутив с Hyprland
+
+#### Настройки сборки
+`--nvidia` - Собрать дистрибутив с драйверами NVIDIA
+
+`--all` - Собрать все дистрибутивы (default + nvidia)
+
+`-r` | `--repos` - Установить используемые во время сборки репозитории (По умолчанию: sisyphus,ximper)
+
+`--net` | `--network` - Использовать сетевые репозитории
+
+#### Прочее
+`--debug` - Включить режим отладки
+
+`--clean` - Очистить TMP перед сборкой
+
+`--vm` - Собрать дистрибутив для виртуальной машины (доступно на gefest) 
+
+## Внесение изменений в подмодуль
+
+Для изменения подмодулей, например, mkimage-profiles нужно выполнить несколько действий.
+
+### Переходим в подмодуль и переключаемся на нужную ветку
+Подмодули синхронизируются с коммитом, а не веткой, поэтому всегда нужно переключаться на нужную ветку.
+
+```
+cd mkimage-profiles/
+git checkout next
+```
+
+### Вносим изменения и синхронизируем проект
+После внесения изменений через любой редактор, выполняем следующие действия
+
+```
+git add .
+git commit -m "..."
+git push
+
+cd ..
+git add mkimage-profiles/
+git commit -m "update submodule"
+git push
+```
+
+## License
+
+GPL-3.0 License
+
+**Copyright © 2024 Etersoft**