From 9a4fcaaaaffc673cec6b64078a76d015c068e2d2 Mon Sep 17 00:00:00 2001 From: Thomas Schmelzer Date: Sun, 19 Jan 2025 19:54:06 +0400 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 99bcab0..f9d8218 100644 --- 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