Update README.md

tschm · Jan 19, 2025 · 9a4fcaa · 9a4fcaa
1 parent 18c901d
commit 9a4fcaa
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,21 @@ Cradle is a command-line utility that creates projects from templates.
 It is similar to the popular
 [Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/#) project.
 
+To use the tool in its current shape do
+
+```bash
+make install
+```
+
+to setup the virtual environment for it (which also installs uv). Then do
+
+```bash
+uv run cradle
+```
+
+to run the tool. 
+
+
 ### Help
 
 We essentially expose the copier interface directly with