From fd1ffa27fca24761d647590d1ac52955942832b4 Mon Sep 17 00:00:00 2001 From: Callum Forrester Date: Tue, 23 Jan 2024 15:28:23 +0000 Subject: [PATCH] Update README.md Update README with correct usage info: - Add `--trust` CLI argument which is required to run the `git init` task - Remove `$` from CLI instructions so they can be copy/pasted wholesale into the terminal --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 27a619d9..1cf925ca 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,9 @@ Visit and you will see a list of templ You will need to `pip install copier` inside an activated `venv`, then you can create a new module via: ``` -$ mkdir /path/to/my-project -$ copier copy gh:DiamondLightSource/python-copier-template /path/to/my-project +mkdir /path/to/my-project +# The --trust argument is required to run setup tasks such as initializing a git repository +copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/my-project ``` You can also use it via `pipx run copier` if you have that installed.