GradienceDocs/usage.rst

106 lines
3.3 KiB
ReStructuredText

.. highlight:: shell
========
🎨 Usage
========
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/welcome.png
:alt: Welcome to Gradience!
Gradience is splitted in 3 tabs plus some top level windows.
Colors
------
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/colors.png
:alt: Image of the Colors tab
The first tab is the one you see first when you open Gradience and called "Colors" is used for
customizing your desktop. Each row is customizing a color like the primary color.
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/row.png
:alt: Row picture
You can customize the color by clicking on the color picker or by clicking on the
pen which will allow you too use an hexadecimal input.
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/hex_row.png
:alt: Hex row picture
.. note::
You can press the information button to see more about a row
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/info_button.png
:alt: Information button
Monet
-----
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/monet.png
:alt: Image of the Monet tab
Monet is an engine made by Google for creating a color theme from your wallpaper.
In Gradience, you can either choose to use your wallpaper or to use a custom picture
by selecting your file (SVG, PNG, JPEG are supported). After selecting a picture,
Gradience will show you the selected colors and you will just have to press the apply
button to apply the palette to the Colors tab.
.. note::
You can use a light or dark palette by selecting the theme
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/theme_switch_monet.png
:alt: Monet theme switcher
Advanced
--------
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/advanced.png
:alt: Image of the advanced tab
Finally, the last tab which is especially designed for an advanced usage. From this tab
you can use a custom CSS
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/custom_css.png
:alt: Custom CSS
Or you can use plugins! Plugins are developed by the community for customizing more apps
like Firefox. They usually require a special setup. You can enable or disable each plugin
and customize their settings.
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/plugin_row.png
:alt: Plugin row
Apply ...
---------
When your work is done, you can press the Apply button which will ask you which apps you want
to theme and finally confirm and enjoy your customizations.
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/apply.png
:alt: Apply dialog
.. warning::
If the theme is not applied, try to close apps or to log out/log in
... Save ...
------------
Usually, you want to save your work. This can be done by pressing the disk icon in the topbar.
After, you will be able to name your preset and to save it!
.. image:: https://raw.githubusercontent.com/GradienceTeam/Design/main/Screenshots/save.png
:alt: Save dialog
... and Share
-------------
Gradience provide a community repo for sharing presets. Go to the Github_ repo and follow
the guide!
.. _Github: https://github.com/GradienceTeam/Community