Skip to content

Commit

Permalink
Add uvx instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
fpgmaas committed Sep 3, 2024
1 parent 2363474 commit 012ea9f
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 7 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 3 additions & 5 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 012ea9f

Please sign in to comment.