mirror of
https://github.com/GradienceTeam/Docs.git
synced 2024-09-27 10:07:54 +00:00
content: update some .rst files and update README.md
This commit is contained in:
parent
9ef8e9322f
commit
aafa2f901f
6 changed files with 18 additions and 20 deletions
|
@ -1,4 +1,4 @@
|
||||||
# Documentation
|
# Gradience User Documentation
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
|
|
6
cli.rst
6
cli.rst
|
@ -24,7 +24,7 @@ If using Gradience as a Flatpak package, launch CLI with:
|
||||||
Alternative approach:
|
Alternative approach:
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
Launch CLI with a dedicated command: `gradience-cli`
|
Launch CLI with a dedicated command: ``gradience-cli``
|
||||||
|
|
||||||
CLI global help:
|
CLI global help:
|
||||||
----------------
|
----------------
|
||||||
|
@ -177,9 +177,9 @@ Flatpak-overrides
|
||||||
Raw JSON output
|
Raw JSON output
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Some commands contain local parameter `--json` to help developers in implementing interactions with Gradience. Currently it can only be used with a handful of available arguments, but there are plans to extend this feature to all arguments. This parameter when used with supported argument, will output argument result in JSON format.
|
Some commands contain local parameter ``--json`` to help developers in implementing interactions with Gradience. Currently it can only be used with a handful of available arguments, but there are plans to extend this feature to all arguments. This parameter when used with supported argument, will output argument result in JSON format.
|
||||||
|
|
||||||
Example with `favorites` command:
|
Example with ``favorites`` command:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -6,10 +6,6 @@
|
||||||
Welcome to Gradience's documentation!
|
Welcome to Gradience's documentation!
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
.. automodule:: gradience
|
|
||||||
:members:
|
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
|
|
@ -63,7 +63,7 @@ You can either clone the public repository:
|
||||||
|
|
||||||
$ git clone git://github.com/GradienceTeam/Gradience
|
$ git clone git://github.com/GradienceTeam/Gradience
|
||||||
|
|
||||||
Or download the `tarball`_:
|
or download the `tarball`_:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
|
|
@ -3,3 +3,5 @@
|
||||||
==================
|
==================
|
||||||
🐛 Troubleshooting
|
🐛 Troubleshooting
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
Work in progress 🚧️
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
========
|
========
|
||||||
|
|
||||||
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/welcome.png
|
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/welcome.png
|
||||||
:alt: Welcome to gradience !
|
:alt: Welcome to Gradience!
|
||||||
|
|
||||||
Gradience is splitted in 3 tabs plus some top level windows.
|
Gradience is splitted in 3 tabs plus some top level windows.
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ Colors
|
||||||
------
|
------
|
||||||
|
|
||||||
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/colors.png
|
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/colors.png
|
||||||
:alt: Image of the colors tab
|
: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
|
The first tab is the one you see first when you open Gradience and called "Colors" is used for
|
||||||
|
@ -40,7 +40,7 @@ Monet
|
||||||
-----
|
-----
|
||||||
|
|
||||||
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/monet.png
|
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/monet.png
|
||||||
:alt: Image of the monet tab
|
:alt: Image of the Monet tab
|
||||||
|
|
||||||
Monet is an engine made by Google for creating a color theme from your wallpaper.
|
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
|
In Gradience, you can either choose to use your wallpaper or to use a custom picture
|
||||||
|
@ -65,7 +65,7 @@ Finally, the last tab which is especially designed for an advanced usage. From t
|
||||||
you can use a custom CSS
|
you can use a custom CSS
|
||||||
|
|
||||||
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/custom_css.png
|
.. image:: https://github.com/GradienceTeam/Design/raw/main/Screenshots/custom_css.png
|
||||||
:alt: Custom css
|
:alt: Custom CSS
|
||||||
|
|
||||||
Or you can use plugins! Plugins are developed by the community for customizing more apps
|
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
|
like Firefox. They usually require a special setup. You can enable or disable each plugin
|
||||||
|
|
Loading…
Reference in a new issue