Add diagram to README

This commit is contained in:
Oliver Davies 2024-08-18 19:08:26 +01:00
parent 507886cfcc
commit f02fce7ff5
3 changed files with 21 additions and 0 deletions

View file

@ -2,6 +2,8 @@
A CLI tool for generating build configuration files for PHP projects. A CLI tool for generating build configuration files for PHP projects.
![A flowchart of the Build Configs workflow.](./docs/diagram.png)
## Supported Projects ## Supported Projects
### PHP ### PHP

19
docs/diagram.mmd Normal file
View file

@ -0,0 +1,19 @@
flowchart TD
A[build-configs.yaml]
subgraph I[Template Files]
Dockerfile.twig
docker-compose.yaml.twig
phpstan.neon.dist.twig
end
A -->|Include project configuration| B
I -->|Include template files| B
B(Build Configs) -->|Generate configuration files| J
subgraph J[Output Files]
Dockerfile
docker-compose.yaml
phpstan.neon.dist
end

BIN
docs/diagram.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB