Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
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
  • Loading branch information
callumforrester authored Jan 23, 2024
1 parent aaabca1 commit fd1ffa2
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ Visit <https://dev-portal.diamond.ac.uk/create> 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.
Expand Down

0 comments on commit fd1ffa2

Please sign in to comment.