reference to poetry in readme

2023-05-15 22:00:30 +02:00 · 2023-05-15 22:00:30 +02:00 · a4dfffb40d
parent f602579357
commit a4dfffb40d
3 changed files with 5 additions and 4 deletions
--- a/TODO.md
+++ b/TODO.md
@ -1,6 +1,5 @@
 # TODO:

- edit readme to use poetry
 - tests
 - add AGPL
 - add CI
--- a/cookiecutter.project_slug
+++ b/cookiecutter.project_slug
@ -26,6 +26,7 @@ wheels/
 *.egg

 # virtualenv
+.venv/
 venv/

 # mypy
--- a/cookiecutter.project_slug
+++ b/cookiecutter.project_slug
@ -18,13 +18,14 @@ This project if a free software released under the {{ cookiecutter.open_source_l

 ## Dev

-If you want to tinker with this project, you can clone it and install it in editable mode:
+This project is managed by [poetry](https://python-poetry.org/).

+To open a shell in a venv of the project: 
 ```
 git clone {{ cookiecutter.project_url }}.git
 cd {{ cookiecutter.project_slug }}
-python -m venv venv && source venv/bin/activate
-pip install -e .[dev]
+poetry shell
+poetry install
 ```

 ### Test