CouscousPHP
Remote templates: ignore some files
Remote templates can contain files, like https://github.com/CouscousPHP/Template-Default
- README.md
- screenshot.png
We don't want those files when the template is used.
Should we move the documentation to another place? I understand that those files have to be removed from the default template repo so the user doesn't download them right?
I think downloading them is OK, it's mainly that the whole template gets copied into the target directory (i.e. the future website). That is to allow the template to have CSS, JS, …
But here screenshot.png for example is just an image for the CouscousPHP/Template-Default repository readme, it's not used in the template, so in the end it will be published on every website that uses this template.
Should we move the documentation to another place?
You mean moving these files out of https://github.com/CouscousPHP/Template-Default? Then the repository wouldn't have a readme, that would be confusing. Each template might have different configuration variables (some might implement a menu, etc...) so I think we need to have a README in each template.
We have several solutions:
- support having a
couscous.ymlin templates, that would let the template set excluded files (as well as any metadata) - support having a
.couscousignore(like.gitignore) to declare ignored files - …
I like the simplicity of .couscousignore I think.