Skip to content

Commit b378d48

Browse files
committed
docs: update usage information in readme
1 parent bbe0e7f commit b378d48

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ uv tool install maturin
9595
Navigate to where you want to create your project and run:
9696

9797
```bash
98-
uvx cruft create https://github.com/robust-python/cookiecutter-robust-python.git
98+
uvx cruft create https://github.com/robust-python/cookiecutter-robust-python
9999
```
100100

101101
This will prompt you for a few inputs to customize your project:
@@ -113,17 +113,15 @@ After generating your project, set it up for development:
113113
```bash
114114
cd my-awesome-project
115115

116-
# Sets up venv + git (same as nox -s setup-venv && nox -s setup-git)
117-
uvx nox -t env
118-
119-
# Sets up remote repository (requires empty remote repo to exist)
116+
uvx nox -s setup-venv
117+
uvx nox -s setup-git
118+
gh repo create my-awesome-project
120119
uvx nox -s setup-remote
121120
```
122121

123-
**Quick setup:** Run `uvx nox -t env` to execute all environment setup tasks at once.
124-
125-
### General CI
122+
###### *Just a general note, sessions named "setup-..." are not idempotent*
126123

124+
From there all that is left is setting up various integrations like Pypi publishing and Readthedocs as desired.
127125

128126

129127
## Roadmap

0 commit comments

Comments
 (0)