Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vkbo committed Apr 2, 2021
1 parent 3a48a12 commit 96fb892
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/int_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,14 @@ you're running novelWriter from the source code, a local copy of this documentat
generated. It requires the following Python packages on Debian and Ubuntu.

* ``python3-sphinx``
* ``python3-sphinx-rtd-theme``
* ``python3-sphinxcontrib.qthelp``

Or from PyPi:

.. code-block:: console
pip install sphinx sphinxcontrib-qthelp
pip install sphinx sphinx-rtd-theme sphinxcontrib-qthelp
The documentation can then be built from the ``docs`` folder in the source code by running:

Expand Down
13 changes: 13 additions & 0 deletions docs/source/setup_linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,16 @@ all users, run the script with the ``sudo`` command.

.. tip::
All options of the setup script can be listed with: ``./setup.py help``.


Uninstalling Icons
==================

The steps taken by the ``xdg-install`` step can be reversed by running:

.. code-block:: console
./setup.py xdg-uninstall
This will remove the desktop launcher and icons from the system. As above, whether this is done on
the current user, or system wide, depends on whether this command is called with ``sudo`` or not.
1 change: 1 addition & 0 deletions setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,6 @@ install.

`xdg-install` – Install launcher and icons for freedesktop systems. Run as root
or with sudo for system-wide install, or as user for single user install.
Running `xdg-uninstall` will remove the icons.

`win-install` – Install desktop and start menu icons for Windows systems.

0 comments on commit 96fb892

Please sign in to comment.