cybercyst/copier
1
0
Fork 0
mirror of https://github.com/copier-org/copier.git synced 2025-05-05 15:32:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document behavior of generating destination path when copying (#1498)

Browse Source 
* Document behavior of generating destination path when copying

* Update README.md

Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>

* Update docs/generating.md

Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>

* fix: run linting

* Apply suggestions from code review

* Apply suggestions from code review

---------

Co-authored-by: Nathan Simpson <nsimpson@455-g7hgqf4ykt.cust.communityfibre.co.uk>
Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
This commit is contained in:
Nathan Simpson 2025-03-09 20:02:05 +00:00 committed by GitHub
parent cc9aacb007
commit 9b0f2b6956
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/generating.md
View File

@ -18,6 +18,10 @@ Or within Python code:
copier.run_copy("path/to/project/template", "path/to/destination")
```
If `path/to/destination` doesn't exist, Copier will create the directory and populate it
with the generated files. If `path/to/destination` exists, it must be writable (not
read-only).
The "template" parameter can be a local path, an URL, or a shortcut URL:
- GitHub: `gh:namespace/project`