From 65813eac54280aa6d851632cad8e30961dcd7106 Mon Sep 17 00:00:00 2001 From: Vinicius Moreira Date: Tue, 1 Dec 2020 12:14:17 -0300 Subject: [PATCH] [README] custom themes: explaining the 'abstract' attribute --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 83e5e383..8d1e88a1 100644 --- a/README.md +++ b/README.md @@ -277,6 +277,7 @@ environment: - description: theme's description that will be displayed on the interface. It supports translations like `name` (e.g: description[es] = Mi tema). - version: theme's version. It just works as information at the moment. (e.g: 1.0) - root_theme: optional attribute that points to a theme that must be loaded before the theme. It supports the bauh's default theme keys (e.g: default, light, ...) or a file path (e.g: `/path/to/root/file.qss`). + - abstract: optional boolean attribute (true/false) that should only be used by themes that are not complete on their own and just work as a base (root) for other themes. Abstract themes are not displayed on the interface. Full example: [default.qss](https://raw.githubusercontent.com/vinifmor/bauh/qss/bauh/view/resources/style/default/default.qss) - **my_theme.vars**: optional file defining `key=value` pairs of variables that will be available for the .qss file (can be referenced through the symbol **@**. e.g `@my_var`). Full example: [light.vars](https://raw.githubusercontent.com/vinifmor/bauh/qss/bauh/view/resources/style/light/light.vars) - common theme variables available: - **style_dir**: path to the .qss file directory. Example: @style_dir/my_icon.svg