NextcloudThemer/example/README.md
2025-02-13 18:38:02 -06:00

16 lines
No EOL
802 B
Markdown

# Example
Move the contents of this "example" folder into the project's root directory in order to add themes.
Asset images can be held anywhere, but it's best to hold it in the `/assets/` folder for cleanliness.
## Theme example
```
Doohickey Corporation -- Instance name
a company that specializes in the creation of technology -- Instance slogan
/assets/doohickey.png -- Image asset - path from root of project
background.png -- "Saved file" name - usually "background" then the extension of the image
image/png -- MIME type - usually "image/png" or "image/jpeg"
#FFFF00 -- Accent color - in hex
```
If you are on Windows or any system that uses `CR LF`, make sure you are saving the file with `LF` and not `CR LF`. Text editors like Notepad++ and Visual Studio Code should support changing this.