Create README.md

bfbaa340 · Grigoriev Semyon · GitHub · bfbaa340
--- a/README.md
+++ b/README.md
+# Шаблон для fastapi проекта
+
+---
+## Использование
+1) Установите cookiecutter 
+$ pip install cookiecutter
+
+2) Перейдите в ту директорию, где у вас будет хранится код для проекта
+Это делается комадами $ cd, $ pwd, $ ls
+Гуглите их, если у вас будет что-то не получаться
+
+3) Выполните раскатку шаблона в текущую директорию командой
+$ cookiecutter https://github.com/profcomff/fastapi-template.git
+
+После команды вас спросят, хотите ли вы загрузить шаблон, согласитесь.
+
+Вам зададут несколько вопросов:
+3.1) repo_name - имя будущего репозитория
+3.2) module_name - имя модуля, который будет запускаться командой: python3 -m module_name. На одном уровне с ним будут лежать Dockerfile, .gitignore, .env, Makefile, docker-compose, pyproject.toml, flake8.conf, README.md, requirements.txt, alembic.ini, gunicorn.conf, миграции. А внутри будет лежать исполняемый код.
+3.3) description - Краткое описание проекта для README.md
+
+4) У вас создастся структура проекта, корнем которой будет папка repo_name. Вы должны создать новый пустой репозиторий на GitHub и импортировать туда все из этой папки.