From 52436dc186c6d73a17f01ec6a74481b3937b18c8 Mon Sep 17 00:00:00 2001
From: Colin Goutte <cgte@bk.ru>
Date: Wed, 23 Aug 2023 17:06:10 +0200
Subject: [PATCH] Add readme

---
 Makefile     | 12 ++++++++++++
 MakefileVenv |  6 +++++-
 Pipfile      |  2 +-
 README.rst   | 41 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 59 insertions(+), 2 deletions(-)
 create mode 100644 README.rst

diff --git a/Makefile b/Makefile
index 73fd373..dfd4489 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,15 @@
+clean:
+	pipenv --rm
+
+install:
+	pipenv install
+
+install_dev:
+	pipenv install --dev
+	make requirements
+
+run_dev:
+	pipenv run python dev.py
 
 tdd:
 	git ls-files | entr pipenv run pytest --lf --nf
diff --git a/MakefileVenv b/MakefileVenv
index 518b8a0..8d2c0a8 100644
--- a/MakefileVenv
+++ b/MakefileVenv
@@ -18,11 +18,15 @@ clean: _delete_venv _create_venv
 install:
 	$(python) -m pip install -r requirements.txt
 
+install_dev:
+	$(python) -m pip install -r requirements_dev.txt
+
+
 test:
 	already_in_venv=True $(python) -m unittest discover .
 
 
-run:
+run_dev:
 	$(python) dev.py
 
 
diff --git a/Pipfile b/Pipfile
index 968fa0b..d3a82e4 100644
--- a/Pipfile
+++ b/Pipfile
@@ -9,4 +9,4 @@ name = "pypi"
 pytest = "*"
 
 [requires]
-python_version = "3.10"
+python_version = "3.12"
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..a9b375f
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,41 @@
+###########
+Documentation the movie API project
+###########
+
+********
+Context
+********
+
+We want to code a sample api to so show workskills
+
+========
+Stack
+========
+
+# Fraweworks
+I choose to use `FastAPI <https://fastapi.tiangolo.com/>`
+
+Environement / Install
+----------------------
+
+We assume make is installed
+
+
+if pipenv is installed:
+
+.. code block:: shell
+
+   make clean install run_dev
+
+
+
+if pipenv is *not* installed
+
+.. code block:: shell
+
+  make -f MakefileVenv clean install run_dev
+
+
+
+I suggest you have pipenv installed, this projet is writtent under python 3.12 and may work on other versiona
+We have a requirement of being virtualenv compatible while i will  working with Pipenv.