From dcb215f6b355c10d8ae6227d0f58abada6914e16 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Sat, 14 Nov 2020 13:27:44 +0000 Subject: [PATCH] Notes on custom themes --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50d3a9970..df5f31613 100644 --- a/README.md +++ b/README.md @@ -250,10 +250,12 @@ If you want to add a new theme then open `theme.py` and add the theme name to th Add the name of your theme to the translations files. -Within the `img` directory add a default profile background image called `image_[YourThemeName].png` and a banner image `banner_[YourThemeName].png`. Because the banner image will be reloaded occasionally it should be small - preferably kilobytes rather than megabytes. +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. +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. + ## Running Unit Tests