From 1bc18cdc6929bf132eedd86e0a956ec1c16bc18e Mon Sep 17 00:00:00 2001
From: David Benque <david@cryptpad.org>
Date: Mon, 13 Jan 2025 16:47:45 +0000
Subject: [PATCH] Document UV project management

---
 README.md | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 94c337cc..dccb9252 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,36 @@
 # CryptPad Documentation
 ## Installation 
-Using [Poetry](https://python-poetry.org/docs/)
+
+### UV
+
+To use [UV](https://docs.astral.sh/uv/#getting-started), install dependencies with 
+
+```bash
+uv sync
+```
+
+Activate the environment with 
+
+```bash
+source ./.venv/bin/activate
+```
+
+Keep `requirements.txt` up to date with the UV venv by running
+
+```bash
+uv export --format requirements-txt
+```
+
+### Poetry 
+
+To use [Poetry](https://python-poetry.org/docs/) rename `pyprojet-poetry.toml` to `pyproject.toml` and run
 ```bash
 poetry install
 ```
+Activate the environment with 
 
-or Pip
 ```bash
-pip install -r requirements.txt
+poetry shell
 ```
 
 Keep `requirements.txt` up to date with the Poetry environment by running 
@@ -16,6 +39,12 @@ Keep `requirements.txt` up to date with the Poetry environment by running
 poetry export -f requirements.txt --output requirements.txt
 ```
 
+### Pip
+```bash
+pip install -r requirements.txt
+```
+
+
 ## Build
 English `en` is the default language.