diff --git a/docs/source/index.rst b/docs/source/index.rst index f4afdeabc..59a0ab4a7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,6 +4,7 @@ Guake User Documentation ======================== .. image:: ../../guake/data/pixmaps/intro-small.jpg + :alt: computer with guake terminal Welcome to the official Guake User Documentation. @@ -18,7 +19,7 @@ Main Features - Simple Easy and Elegant - Smooth integration of terminal into GUI - Appears when you call and disappears once you are done by pressing a predefined hotkey (F12 by - default) + default) - Compiz transparency support - Multi tab - Plenty of color palettes @@ -44,10 +45,10 @@ Useful links - Source Code available on `GitHub `_. - Official Homepage: http://guake-project.org - Online Documentation is hosted on `ReadTheDocs `_. -- If you are not a developer, you can still contribute to Guake by - `improving its translations in your language `_ in providing this - service for free for OpenSource Projects. +- If you are not a developer, you can still contribute to Guake by + `improving its translations in your language `_. + Guake users are welcome `to support Weblate `_ in providing this + service for free for OpenSource Projects. **Important note**: Do **NOT** use the domain guake.org, it has been registered by someone outside the team. We cannot be held responsible for the content on that web site. diff --git a/docs/source/user/installing.rst b/docs/source/user/installing.rst index e62c7a7d9..fedf0d3e7 100644 --- a/docs/source/user/installing.rst +++ b/docs/source/user/installing.rst @@ -52,7 +52,7 @@ Guake is available on *community* repository, just use: ``sudo pacman -S guake`` Manjaro ------- +------- Manjaro users can use ``pacman -S guake``. @@ -62,19 +62,19 @@ Install from Pypi Guake is now automatically published on Pypi. -Please note the recommended way is to install Guake using `pipx` that will put Guake in a -dedicated, isolated environment for your local user. Ensure `$HOME/.local/bin` is in your `PATH`. +Please note the recommended way is to install Guake using ``pipx`` that will put Guake in a +dedicated, isolated environment for your local user. Ensure ``$HOME/.local/bin`` is in your ``PATH``. .. code-block:: bash - $ python3 -m pip install --user pipx - $ pipx install guake + $ python3 -m pip install --user pipx + $ pipx install guake Alternatively, you can use the following command to install on a local environment: .. code-block:: bash - $ pip install --user guake + $ pip install --user guake Avoid using ``pip install guake`` without the ``--user``, you may break your system. @@ -83,19 +83,18 @@ You need to ensure the following points are met in your configuration: - ``$HOME/.local/bin`` should be in your ``$PATH`` - You need to have some dependencies installed on your system: - - - ``gir1.2-keybinder-3.0`` - - ``gir1.2-notify-0.7`` - - ``gir1.2-vte-2.91`` - - ``libkeybinder-3.0-0`` - - ``libutempter0`` - - ``python3-setuptools`` - - ``python3-cairo`` - - ``python3-dbus`` - - ``python3-gi`` - - ``python3-pbr`` - - ``python3-pip`` - - ``python3`` + - ``gir1.2-keybinder-3.0`` + - ``gir1.2-notify-0.7`` + - ``gir1.2-vte-2.91`` + - ``libkeybinder-3.0-0`` + - ``libutempter0`` + - ``python3-setuptools`` + - ``python3-cairo`` + - ``python3-dbus`` + - ``python3-gi`` + - ``python3-pbr`` + - ``python3-pip`` + - ``python3`` Install from source =================== @@ -103,20 +102,20 @@ Install from source If you want to install Guake from its sources, please follow this procedure: - First, **DO NOT USE TARBALLS GENERATED BY GITHUB** on the Release Page. They - are automatically generated and cannot be used alone. We use a package, namely -  ``PBR``, that requires the full git history to work. + are automatically generated and cannot be used alone. We use a package, namely + ``PBR``, that requires the full git history to work. - Checkout the HEAD of the source tree with: + Checkout the HEAD of the source tree with: - .. code-block:: bash + .. code-block:: bash $ git clone https://github.com/Guake/guake.git - make sure that you have the needed system dependencies (Python GTK, VTE, ...) - installed for your system. - If you are unsure about the dependencies, you can run this script to install them: + installed for your system. + If you are unsure about the dependencies, you can run this script to install them: - .. code-block:: bash + .. code-block:: bash $ ./scripts/bootstrap-dev-[debian, arch, fedora].sh run make @@ -126,20 +125,20 @@ To install Guake itself, use: .. code-block:: bash - $ make - $ sudo make install + $ make + $ sudo make install To uninstall, still in the source directory: .. code-block:: bash - $ make - $ sudo make uninstall + $ make + $ sudo make uninstall Tips for a complete Guake reinstallation (without system dependencies): .. code-block:: bash - $ sudo make uninstall && make && sudo make install - $ # Or use this shortcut: - $ make reinstall # (do not sudo it!) + $ sudo make uninstall && make && sudo make install + $ # Or use this shortcut: + $ make reinstall # (do not sudo it!)