I've attempted to simplify the user-facing quick-start instructions. Not a huge fan of enumerated instructions and the optional (but cool) one-liner it doesn't really fit in 1. 2. 3....
Also it's a bit overkill to have a venv/conda environment just for cookiecutter itself. The cookiecutter docs recommend pipx install. I claim that we want to encourage uvx because it's fast and cool 😎 .
I've spent a bit of effort trying to be clear but comments on clarity etc are very welcome.
I also moved and merged the dev instructions into CONTRIBUTING so README is just user-facing. And CONTRIBUTING is just dev.
samcunliffe
commented
3 weeks ago
I've attempted to simplify the user-facing quick-start instructions. Not a huge fan of enumerated instructions and the optional (but cool) one-liner it doesn't really fit in 1. 2. 3....
Also it's a bit overkill to have a venv/conda environment just for cookiecutter itself. The cookiecutter docs recommend
pipx install. I claim that we want to encourageuvxbecause it's fast and cool 😎 .I've spent a bit of effort trying to be clear but comments on clarity etc are very welcome.
I also moved and merged the dev instructions into CONTRIBUTING so README is just user-facing. And CONTRIBUTING is just dev.
This addresses
466
And two comments