Skip to content

Commit 966f726

Browse files
authored
added adopting template docs (#99)
2 parents db68171 + 2941e00 commit 966f726

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

docs/tutorials/adopt-existing.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
11
# Adopt the template into an existing repo
22

3-
TODO
3+
To adopt the latest version of this template to an existing project run:
4+
```shell
5+
copier copy gh:DiamondLightSource/python-copier-template /path/to/existing-project
6+
```
7+
8+
This will:
9+
10+
- Ask some questions about the existing project
11+
- Expand the template with the answers given
12+
- Ask if you would like to overwrite conflicting files (always choose yes)
13+
- Record the answers in the project so they can be used in later updates
14+
15+
## Conflicting Files
16+
After choosing to overwrite the conflicting files, open your project in an editor and go through the changes and any merge conflicts ensure that you have the right files and contents.
17+
18+
:::{note}
19+
Copier does not touch any already existing files that do not conflict with the ones in the template. Therefore, you may end up with files in your project you no longer need such as old github workflows. These would need to be manually deleted.
20+
:::

0 commit comments

Comments
 (0)