Skip to content

Commit 1efbd7a

Browse files
committed
Add a warning about the cookiecutter command
Many people thought they need to customize how the cookiecutter command is invoked leading to a lot of confusion, so we add a warning and small explanation to make it clear that the command needs to be typed as is. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 61be1f2 commit 1efbd7a

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

docs/index.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,29 @@ Collecting cookiecutter
3131
...
3232
```
3333

34-
Then simply run [Cookiecutter] where you want to create the new project. A new
35-
directory will be created with the generated project name. For example:
34+
Then simply run [Cookiecutter] where you want to create the new project:
3635

3736
```sh
38-
cd ~/devel
39-
cookiecutter gh:frequenz-floss/frequenz-repo-config-python --directory=cookiecutter
37+
cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
38+
--directory=cookiecutter
4039
```
4140

4241
This command will prompt you for the project type, name, and other
43-
configuration options, and it will generate the entire project for you.
42+
configuration options, and it will generate the entire project for you in a new
43+
subdirectory.
44+
45+
!!! warning
46+
47+
This command needs to be typed literally!
48+
49+
`frequenz-floss/frequenz-repo-config-python` is the GitHub repository with
50+
the cookiecutter template that will be downloaded, and
51+
`--directory=cookiecutter` is needed because the cookiecutter template
52+
doesn't live at the top-level of that repository, but in a subdirectory
53+
called `cookiecutter`.
54+
55+
All information about your project will be prompted interactively by that
56+
command.
4457

4558
After completing the project and fixing the `TODO`s, you can either amend the
4659
previous commit using `git commit --amend` or create a new commit for the

0 commit comments

Comments
 (0)