Skip to content

Commit 4ca9877

Browse files
committed
more opinionated blathering
1 parent 9c5f168 commit 4ca9877

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ This is how I like to lay my Python projects out. You don't have to do it
44
this way, but this way works for me.
55

66
You can use it as a template, if you're reading this on GitHub then push the
7-
"Use this template" button
7+
"Use this template" button. You'll need to edit the project name in two
8+
places:
9+
10+
1. In `pyproject.toml`, along with the other metadata about your project. It
11+
goes `in_snake_case`, and matches the dir in the `src` dir.
12+
2. In `Makefile`, which is `in-kebab-case`. Why? Because convention says so,
13+
which is a poor excuse, but it's better than not following conventions.
814

915
## To run me
1016

0 commit comments

Comments
 (0)