Skip to content

Commit 2f163be

Browse files
authored
Merge pull request #39 from 56kyle/develop
Add README.md Links
2 parents bd0de0f + f6b0e9d commit 2f163be

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,22 @@
22

33
A Python project template robust enough to follow up [cookiecutter-hypermodern-python]
44

5+
---
6+
7+
**[📚 View Documentation](https://cookiecutter-robust-python.readthedocs.io/)** | **[🐛 Report a Bug](https://github.com/56kyle/cookiecutter-robust-python/issues)** | **[✨ Request a Feature](https://github.com/56kyle/cookiecutter-robust-python/issues)**
8+
9+
---
10+
511
## Usage/Installation
612

713
The only prerequisite for using the template is to [install uv].
814

915
From there just cd into the directory you want to create the project in and run:
1016
```terminaloutput
1117
uvx cruft create https://github.com/56kyle/cookiecutter-robust-python.git
18+
```
19+
Which will prompt you for a few inputs before generating the project.
20+
```terminaloutput
1221
> [1/15] project_name (robust-python): my-repo-name
1322
> ...
1423
```

0 commit comments

Comments
 (0)