NextcloudThemer/example/README.md

20 lines
990 B
Markdown
Raw Normal View History

2025-02-14 00:38:02 +00:00
# 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
2025-02-14 00:38:30 +00:00
background.png -- "Saved file" name - usually "background", then the extension of the image
2025-02-14 00:38:02 +00:00
image/png -- MIME type - usually "image/png" or "image/jpeg"
#FFFF00 -- Accent color - in hex
```
2025-02-14 00:49:00 +00:00
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.
You can copy the .txt to create as many themes as you desire. Make sure they have identifiable names.
Once you are done, the application should see the `/themes/` folder and work well.