Skip to content

Commit 8cc98d6

Browse files
committed
Updated README.md
Updated tree view of generated project, wordsmithing.
1 parent 13a74f8 commit 8cc98d6

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,12 @@ you and people that interact with your project repository.
1818

1919
- Choose from a [plethora][plethora] of Open Source licenses.
2020
- Automatically detects GitHub user name and email address (if configured).
21+
- Installs requested version of development Python if needed.
2122
- Creates a virtual environment in the project directory.
2223
- Enables `direnv` for this subdirectory if `direnv` available.
2324
- Automatically syncs dependencies and the project into virtual environment.
2425
- Automatically initializes a git repository with a main branch.
25-
- Automatically creates initial commit.
26+
- Automatically creates an initial git commit.
2627
- Optionally creates an upstream repository and pushes (GitHub only, requires [gh][gh]).
2728

2829
## Package Features
@@ -37,11 +38,14 @@ you and people that interact with your project repository.
3738
- Publish to PyPI via GitHub Actions with `poe publish`.
3839
- Development tool options integrated into pyproject.toml.
3940
- Generic GitHub Issue and Pull Request templates.
41+
- Configured to use [dependabot][dependabot] dependency checker.
42+
- Checks project dependencies.
43+
- Checks project GitHub action dependencies.
4044
- Operating System and Python version test matrices.
4145
- Configured to use [direnv][direnv] to automatically activate & deactivate venvs.
4246
- Optionally configured badges in README.md for cool points.
43-
- Optionally configured [dependabot][dependabot] dependency checker.
4447
- Optionally managed CLI settings using [pydantic-settings][pydantic-settings].
48+
- Optionally logs to a file.
4549

4650
## Prerequisites
4751

@@ -62,7 +66,7 @@ you and people that interact with your project repository.
6266

6367
## Creating Your Project
6468

65-
Once you have `uv` installed, you get `uvx` for free!
69+
6670

6771
If you haven't authenticated to GitHub with `gh` yet and you plan to
6872
ask `cookiecutter` to create the upstream repository, you should do
@@ -72,7 +76,8 @@ that now:
7276
gh auth login
7377
```
7478

75-
All done? Now you are ready to create your project:
79+
All done? Now you are ready to create your project and the good news
80+
is once you install `uv` you get the great tool runner `uvx` for free!
7681

7782
```console
7883
uvx cookiecutter gh:JnyJny/python-package-cookiecutter
@@ -125,8 +130,7 @@ $ tree -a -I .venv -I .git
125130
│   └── thing
126131
│   ├── __init__.py
127132
│   ├── __main__.py
128-
│   ├── self_subcommand.py
129-
│   └── settings.py
133+
│   └── self_subcommand.py
130134
├── tests
131135
│   └── __init__.py
132136
└── uv.lock

0 commit comments

Comments
 (0)