From 012ea9f00f474c35b0690f55f6cf32148dae6f31 Mon Sep 17 00:00:00 2001 From: Florian Maas Date: Tue, 3 Sep 2024 19:54:38 +0200 Subject: [PATCH] Add uvx instructions --- README.md | 8 +++++++- docs/index.md | 8 +++++++- docs/tutorial.md | 8 +++----- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c34aedf..e57836f 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,13 @@ This is a modern Cookiecutter template that can be used to initiate a Python pro ## Quickstart On your local machine, navigate to the directory in which you want to -create a project directory, and run the following two commands: +create a project directory, and run the following command: + +```bash +uvx cookiecutter https://github.com/fpgmaas/cookiecutter-uv.git +``` + +or if you don't have `uv` installed yet: ```bash pip install cookiecutter diff --git a/docs/index.md b/docs/index.md index 3ff07fd..6c961c5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,7 +28,13 @@ An example of a repository generated with this package can be found [here](https ## Quickstart On your local machine, navigate to the directory in which you want to -create a project directory, and run the following two commands: +create a project directory, and run the following command: + +```bash +uvx cookiecutter https://github.com/fpgmaas/cookiecutter-uv.git +``` + +or if you don't have `uv` installed yet: ```bash pip install cookiecutter diff --git a/docs/tutorial.md b/docs/tutorial.md index 195bd95..5bd0a92 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -13,13 +13,11 @@ curl -LsSf https://astral.sh/uv/install.sh | sh ## Step 2: Generate your project -First, navigate to the directory in which you want the project to be -created. Then, we need to install `cookiecutter-uv` with the -following command: +On your local machine, navigate to the directory in which you want to +create a project directory, and run the following command: ```bash -pip install cookiecutter -cookiecutter https://github.com/fpgmaas/cookiecutter-uv.git +uvx cookiecutter https://github.com/fpgmaas/cookiecutter-uv.git ``` For an explanation of the prompt arguments, see