Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
andreymal committed Dec 26, 2023
1 parent 45c7b1b commit f4759d8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 7 deletions.
30 changes: 25 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
* Устанавливаем системные зависимости:

* Python 3.8-3.11
* Poetry
* Node.JS
* Yarn
* [Poetry] (официальная документация рекомендует устанавливать его через
[pipx]; не забудьте настроить переменную окружения `PATH`)
* [Node.js]
* [Yarn]
* GNU Make (для Windows можно взять из MinGW; можно не брать, но тогда
придётся запускать команды из `Makefile` вручную)

Expand All @@ -18,9 +19,20 @@
cd mini_fiction
```

* Устанавливаем проект командой `make develop`. Проект управляется с помощью
* Подготавливаем окружение для разработки. Проект управляется с помощью
Poetry, который автоматически создаст виртуальное окружение и установит
в него все обязательные зависимости.
в него все обязательные зависимости. Перед выполнением команды убедитесь,
что в вашем текущем окружении доступны команды `poetry` и `yarn`.

```
make develop
```

* По желанию можно доустановить опциональные зависимости:

```
poetry install --all-extras
```

* После установки можно для удобства сразу активировать виртуальное окружение:

Expand Down Expand Up @@ -347,4 +359,12 @@ location /static {
Можно попробовать поискать архивы и репозитории с готовой конфигурацией
всего этого.

[Poetry]: https://python-poetry.org/

[pipx]: https://github.com/pypa/pipx

[Node.js]: https://nodejs.org/en

[Yarn]: https://yarnpkg.com/

[long-term caching]: https://developers.google.com/web/fundamentals/performance/webpack/use-long-term-caching
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ CMS currently in Russian, and we would be grateful for the translation of all ph

mini_fiction is available on PyPI, but it's recommended to use the latest version from GitHub since it's
more up-to-date. Install Python 3.8-3.11 and the development tools ([Git], GNU Make, [Poetry], [Node.js]
and [Yarn]), then run the following commands:
and [Yarn]), then run the following commands to set up the development environment:

```bash
git clone https://github.com/andreymal/mini_fiction
cd mini_fiction
make install
make develop
```

This project is managed by Poetry; use `poetry shell` the activate the virtual environment.
Expand Down

0 comments on commit f4759d8

Please sign in to comment.