From f8706d4bbce0863949349e95197a6d2403a0228f Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Sat, 14 Nov 2020 21:28:16 +0000 Subject: [PATCH] Update themes documentation --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ab6523beb..7a9ce56ff 100644 --- a/README.md +++ b/README.md @@ -246,13 +246,11 @@ If you want to use your own favicon then copy your `favicon.ico` file to the bas ## Adding Themes -If you want to add a new theme then open `theme.py` and add a function with the name `setTheme[YourThemeName]`. Have a look at the other themes to get an idea of how to set the colors and fonts. - -Add the name of your theme to the translations files. +If you want to add a new theme then first add the name of your theme to the translations files. Within the `theme` directory create a directory with the name of your theme and add icons and banners. As a quick way to begin you could copy the contents of `theme/default`, then edit the graphics. Keep the size of images as small as possible to avoid creating a laggy user interface. -On a running instance you can experiment with colors or fonts by editing `epicyon.css` and then reloading the web page. Once you are happy with the results then you can update the changed values within your `setTheme` function. +On a running instance you can experiment with colors or fonts by editing `epicyon.css` and then reloading the web page. Once you are happy with the results then you can update the changed variable values within your `theme/yourtheme/theme.json` file. Epicyon normally uses one set of CSS files whose variables are then altered per theme. If you want to use entirely bespoke CSS then copy `epicyon-*.css` into your theme directory and edit it to your requirements. This will be used rather than the default CSS files. Be warned that if you're maintaining the CSS files yourself then you may need to keep up with whatever changes are happening upstream, otherwise your user interface will break.