Skip to content

Commit

Permalink
docs: improve cruft update instructions (#235)
Browse files Browse the repository at this point in the history
  • Loading branch information
lsorber committed Apr 23, 2024
1 parent d9d486e commit a969f1d
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,29 @@ To create a new Python project with this template:
cruft create -f https://github.com/radix-ai/poetry-cookiecutter
```

4. _Optional:_ if your repository name differs from your project's slugified name (see `project_name` in the [Template parameters](https://github.com/radix-ai/poetry-cookiecutter#-template-parameters) below), you will need to copy the scaffolded project into the repository with:
<details>

```sh
cp -r {project-name}/ {repository-name}/
```
<summary>⚠️ If your repository name ≠ the project's slugified name</summary>
If your repository name differs from your project's slugified name (see `project_name` in the [Template parameters](https://github.com/radix-ai/poetry-cookiecutter#-template-parameters) below), you will need to copy the scaffolded project into the repository with:

```sh
cp -r {project-name}/ {repository-name}/
```

</details>

### Updating your Python project

To update your Python project with the latest template:
To update your Python project to the latest template version:

1. Update the project while verifying the existing template parameters and setting any new parameters, if there are any:

```sh
cruft update --cookiecutter-input
```

1. Run `cruft update` to update your project with the latest template.
2. If any of the updates failed, resolve them by inspecting the generated `.rej` files.
2. If any of the file updates failed, resolve them by inspecting the corresponding `.rej` files.

## 🤓 Template parameters

Expand Down

0 comments on commit a969f1d

Please sign in to comment.