docs: add steps with pre-commit install

This commit is contained in:
Maxim Slipenko 2024-08-26 15:53:19 +03:00
parent 8ec93c89b7
commit 64a4066825
No known key found for this signature in database
GPG Key ID: 6DEA9FA7DE98C7D6

View File

@ -18,12 +18,20 @@ git clone https://gitflic.ru/project/alt-gnome/karkas.git
2. Откройте папку `karkas` в VSCode. Среда разработки автоматически предложит открыть проект как Workspace, используя файл `karkas.code-workspace`. Нажмите `Открыть Workspace`, чтобы принять предложение; 2. Откройте папку `karkas` в VSCode. Среда разработки автоматически предложит открыть проект как Workspace, используя файл `karkas.code-workspace`. Нажмите `Открыть Workspace`, чтобы принять предложение;
3. Установите инструмент Poetry, следуя инструкциям из [официальной документации](https://python-poetry.org/docs/). Для каждого пакета выполните следующую последовательность действий: 3. Установите инструмент Poetry, следуя инструкциям из [официальной документации](https://python-poetry.org/docs/).
4. Выполните команду `poetry install` в корне проекта.
5. Выполните команду `soruce ./.venv/bin/activate` в корне проекта.
4. Выполните команду `pre-commit install -t commit-msg -t pre-commit` в корне проекта.
5. Для каждого пакета выполните следующую последовательность действий:
- Перейдите в папку пакета (например, `src/karkas_core`); - Перейдите в папку пакета (например, `src/karkas_core`);
- Выполните команду `poetry install`, чтобы установить зависимости пакета. После этого будет создано виртуальное окружене (`.venv`); - Выполните команду `poetry install`, чтобы установить зависимости пакета.
4. Выполните команду `poetry shell` в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение. 4. Выполните команду `soruce ./.venv/bin/activate` в папке пакета, над которым будут производится работы, чтобы активировать виртуальное окружение.
Теперь рабочее окружение настроено! Теперь рабочее окружение настроено!