Skip to content

Commit e18b238

Browse files
authored
Improve root docs (#106)
2 parents bf04089 + 9a53116 commit e18b238

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ It integrates the following tools:
3030
- [GitHub Actions](https://docs.github.com/en/actions) to provide CI and deployment to PyPI and GitHub Pages
3131
- [VSCode](https://code.visualstudio.com/docs) settings for running the above tools on save
3232

33+
## Example
34+
35+
You can see the template in action in the [example project](https://github.com/DiamondLightSource/python-copier-template-example). This is an up to date expansion of the template to illustrate how it looks with all the options enabled.
36+
3337
## Create a new project via Developer Portal
3438

3539
> [!NOTE]

docs/tutorials/adopt-existing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Copier will *overwrite* files with the template files. Please check the changes
1818
If you have a [python3-pip-skeleton](https://github.com/DiamondLightSource/python3-pip-skeleton) based project then it is best to adopt the `1.0.0` release of this template, then `copier update` to get to the latest. This is because `copier update` will try and merge file changes across renames done between releases, while `copier copy` cannot. This looks like:
1919

2020
```shell
21-
copier copy gh:DiamondLightSource/python-copier-template --vcs-ref=1.0.0 /path/to/existing-project
21+
copier copy gh:DiamondLightSource/python-copier-template --trust --vcs-ref=1.0.0 /path/to/existing-project
2222
git diff
2323
# Examine the changes, put back anything you want to keep
2424
git commit -m "Adopted python-copier-template 1.0.0"
25-
copier update /path/to/existing-project
25+
copier update --trust /path/to/existing-project
2626
git diff
2727
# Examine the changes, resolve any merge conflicts
2828
git commit -m "Updated to python-copier-template x.x.x"
@@ -33,7 +33,7 @@ git commit -m "Updated to python-copier-template x.x.x"
3333
If you have a project with a different structure then it is best to go straight to the latest release:
3434

3535
```shell
36-
copier copy gh:DiamondLightSource/python-copier-template /path/to/existing-project
36+
copier copy --trust gh:DiamondLightSource/python-copier-template /path/to/existing-project
3737
git diff
3838
# Examine the changes, put back anything you want to keep
3939
git commit -m "Adopted python-copier-template x.x.x"

0 commit comments

Comments
 (0)