Skip to content

Commit 518c071

Browse files
committed
README: Remove the explicit version checkout
Since we can't expand macros in the README, and it is too much work to keep the version updated, we just remove it from there and ask the user to manually check what's the latest version. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 1c8bfea commit 518c071

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,17 @@ directory will be created with the generated project name. For example:
4848

4949
```sh
5050
cd ~/devel
51-
cookiecutter gh:frequenz-floss/frequenz-repo-config-python \
52-
--directory=cookiecutter \
53-
--checkout v0.6.2
51+
cookiecutter gh:frequenz-floss/frequenz-repo-config-python --directory=cookiecutter
5452
```
5553

5654
This command will prompt you for the project type, name, and other
5755
configuration options, and it will generate the entire project for you.
5856

57+
It is recommended to use a released version, you can do that by adding the
58+
option `--checkout <version>` to the command above. You can check which is the
59+
latest version
60+
[here](https://github.com/frequenz-floss/frequenz-repo-config-python/releases/latest).
61+
5962
After completing the project and fixing the `TODO`s, you can either amend the
6063
previous commit using `git commit --amend` or create a new commit for the
6164
changes using `git commit`.

0 commit comments

Comments
 (0)