spalencsar/bearhub
1
0
Fork 0
mirror of https://github.com/spalencsar/bearhub.git synced 2026-07-07 00:04:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

[README] Updating 'Custom themes' section links

Browse Source
This commit is contained in:
Vinicius Moreira
2021-04-08 08:46:32 -03:00
parent f1f496cb5d
commit c88d7f35fe
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -414,15 +414,15 @@ boot:
#### <a name="custom_themes">Custom themes</a> #### <a name="custom_themes">Custom themes</a>
- Custom themes can be provided by adding their files at `~/.local/share/bauh/themes` (sub-folders are allowed). - Custom themes can be provided by adding their files at `~/.local/share/bauh/themes` (sub-folders are allowed).
- Themes are composed by 2 required and 1 optional files sharing the same name: - Themes are composed by 2 required and 1 optional files sharing the same name:
- `my_theme.qss`: file with the qss rules. Full example: [light.qss](https://raw.githubusercontent.com/vinifmor/bauh/qss/bauh/view/resources/style/light/light.qss) - `my_theme.qss`: file with the qss rules. Full example: [light.qss](https://raw.githubusercontent.com/vinifmor/bauh/master/bauh/view/resources/style/light/light.qss)
- `my_theme.meta`: file defining the theme's data. Full example: [light.meta](https://raw.githubusercontent.com/vinifmor/bauh/qss/bauh/view/resources/style/light/light.meta) - `my_theme.meta`: file defining the theme's data. Full example: [light.meta](https://raw.githubusercontent.com/vinifmor/bauh/master/bauh/view/resources/style/light/light.meta)
- available fields: - available fields:
- `name`: name that will be displayed on the interface. It supports translations by adding additional `name` fields with brackets and the language code (e.g: `name[es]=Mi tema`) - `name`: name that will be displayed on the interface. It supports translations by adding additional `name` fields with brackets and the language code (e.g: `name[es]=Mi tema`)
- `description`: theme's description that will be displayed on the interface. It supports translations like `name` (e.g: description[es] = Mi tema). - `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) - `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`). - `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) - `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/master/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) - `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/master/bauh/view/resources/style/light/light.vars)
- common theme variables available: - common theme variables available:
- `style_dir`: path to the .qss file directory. Example: @style_dir/my_icon.svg - `style_dir`: path to the .qss file directory. Example: @style_dir/my_icon.svg
- `images`: path to bauh's icons directory (gem icons are not available through this variable). Example: @images/logo.svg - `images`: path to bauh's icons directory (gem icons are not available through this variable). Example: @images/logo.svg