From 1fb73a0e3fb02a20054af0ff71392af95a4a6eac Mon Sep 17 00:00:00 2001
From: Michael Panchenko <35432522+MischaPanch@users.noreply.github.com>
Date: Sat, 10 Aug 2024 12:35:45 +0200
Subject: [PATCH] Improved result's README.md

---
 {{cookiecutter.project_name}}/README.md | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md
index f7df778..307b6fc 100644
--- a/{{cookiecutter.project_name}}/README.md
+++ b/{{cookiecutter.project_name}}/README.md
@@ -4,15 +4,16 @@ Welcome to the {{cookiecutter.project_name}} library!
 
 ## Getting Started
 
-Clone the repository and run
+You can have a local poetry or docker-interpeter based setup. The repository is also 
+configured to seamlessly working within a GitHub Codespace. See the instructions
+for the various setup scenarios below.
 
-```shell
-git submodule update --init --recursive
-```
-
-to also pull the git submodules.
+Independently of how the setup was done, the virtual environment can be activated with
+`poetry shell` and the various tasks like formatting, testing, and documentation building
+can be executed using `poe`. For example, `poe format` will format the code, including the 
+notebooks. Just run `poe` to see the available commands.
 
-### Python setup
+### Python (poetry) setup
 
 You can install the dependencies with