docs: updating the project (#520)

* doc: add template-sync tool to the documentation

* docs: add a  link tu update.md in README

* fix: pr review

* Update README.md

* Update and rename update.md to updating.md

---------

Co-authored-by: Kévin Dunglas <kevin@dunglas.fr>
This commit is contained in:
Emmanuel Barat 2024-01-03 09:01:39 +01:00 committed by GitHub
parent b6f8692f6f
commit 661beb8178
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 0 deletions

View File

@ -38,6 +38,7 @@ with [FrankenPHP](https://frankenphp.dev) and [Caddy](https://caddyserver.com/)
6. [TLS Certificates](docs/tls.md) 6. [TLS Certificates](docs/tls.md)
7. [Using a Makefile](docs/makefile.md) 7. [Using a Makefile](docs/makefile.md)
8. [Troubleshooting](docs/troubleshooting.md) 8. [Troubleshooting](docs/troubleshooting.md)
9. [Updating the template](docs/updating.md)
## License ## License

15
docs/updating.md Normal file
View File

@ -0,0 +1,15 @@
# Updating Your Project
To import the changes made to the *Symfony Docker* template into your project, we recommend using
[*template-sync*](https://github.com/mano-lis/template-sync):
1. Run the script to synchronize your project with the latest version of the skeleton:
```console
curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template-sync.sh | sh -s -- https://github.com/dunglas/symfony-docker
```
2. Resolve conflicts, if any
3. Run `git cherry-pick --continue`
For more advanced options, refer to [the documentation of *template sync*](https://github.com/coopTilleuls/template-sync#template-sync).