From 48bbe288b7d6d842f71e04b8efbdca517bc4a787 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sun, 21 Mar 2021 16:50:10 +0100 Subject: [PATCH 1/2] Clarify the install instructions for Linux --- docs/source/setup_linux.rst | 42 ++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/docs/source/setup_linux.rst b/docs/source/setup_linux.rst index 4a34cc45..55daeb70 100644 --- a/docs/source/setup_linux.rst +++ b/docs/source/setup_linux.rst @@ -42,34 +42,56 @@ can install them with: Step 2: Install Package (Optional) ---------------------------------- -You can install novelWriter to the correct location for Python packages with: +You can install novelWriter to the default location for Python packages using setuptools. This step +is optional as you can also just put the novelWriter program folder wherever you like. For instance +to ``/opt/novelWriter`` and run Step 3 to set up icons and launcher. + +To install novelWriter to the default location, it requires that you have setuptools installed on +your system. If you don't have setuptools, it can usually be installed from your distro's +repository. For Debian and Ubuntu this is achieved with: .. code-block:: console - ./setup.py install + sudo apt install python3-setuptools + +The package is also available from PyPi: + +.. code-block:: console + + pip3 install --user setuptools + +With setuptools in place, novelWriter can be installed to the user space with: + +.. code-block:: console + + ./setup.py install --user + +This should install novelWriter as ``~/.local/bin/novelWriter``. If you instead want to install for +all users, i.e. as ``/usr/local/bin/novelWriter``, run: + +.. code-block:: console + + sudo ./setup.py install This is equivalent to what the ``pip`` installer does. It puts novelWriter in the location on your system where Python packages are usually kept. This is not really the best suited location for a GUI application like novelWriter, so you may instead copy the entire source to a suiteable location yourself. -This should install novelWriter to either ``~/.local/bin/novelWriter`` if installed for local user -only, or to ``/usr/local/bin/novelWriter`` if installed for all users (with the ``sudo`` command). - Step 3: Create Launcher Icons ----------------------------- -Regardless of where you extract or install the source files, you can easily set up a standard icon -and launcher. To set up this desktop launcher, the needed icons, and the project file association, -run: +Regardless of where you extract or install the source files, you can set up a standard icon and a +launcher. To set up this desktop launcher, the needed icons, and the project file association, +run the following from inside the novelWriter folder: .. code-block:: console ./setup.py xdg-install -By default, these commands install novelWriter and its icons for the current user only. To install -for all users, run the script with the ``sudo`` command. +By default, this command installs the launcher and icons for the current user only. To install for +all users, run the script with the ``sudo`` command. .. tip:: All options of the setup script can be listed with: ``./setup.py help``. From d4c61e7ec90bf1a4390a2235153c1df2405ef56e Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sun, 21 Mar 2021 16:54:53 +0100 Subject: [PATCH 2/2] Update Linux setup for consistency and add more details for macOS --- docs/source/setup_linux.rst | 12 ++++++------ docs/source/setup_mac.rst | 17 ++++++++++++----- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/source/setup_linux.rst b/docs/source/setup_linux.rst index 55daeb70..229d3079 100644 --- a/docs/source/setup_linux.rst +++ b/docs/source/setup_linux.rst @@ -42,12 +42,12 @@ can install them with: Step 2: Install Package (Optional) ---------------------------------- -You can install novelWriter to the default location for Python packages using setuptools. This step -is optional as you can also just put the novelWriter program folder wherever you like. For instance -to ``/opt/novelWriter`` and run Step 3 to set up icons and launcher. +You can install novelWriter to the default location for Python packages using ``setuptools``. This +step is optional as you can also just put the novelWriter program folder wherever you like. For +instance to ``/opt/novelWriter`` and run Step 3 to set up icons and launcher. -To install novelWriter to the default location, it requires that you have setuptools installed on -your system. If you don't have setuptools, it can usually be installed from your distro's +To install novelWriter to the default location, it requires that you have ``setuptools`` installed +on your system. If you don't have it installed, it can usually be installed from your distro's repository. For Debian and Ubuntu this is achieved with: .. code-block:: console @@ -60,7 +60,7 @@ The package is also available from PyPi: pip3 install --user setuptools -With setuptools in place, novelWriter can be installed to the user space with: +With ``setuptools`` in place, novelWriter can be installed to the user space with: .. code-block:: console diff --git a/docs/source/setup_mac.rst b/docs/source/setup_mac.rst index 5b738865..6bc439d9 100644 --- a/docs/source/setup_mac.rst +++ b/docs/source/setup_mac.rst @@ -52,12 +52,19 @@ You can install novelWriter to the correct location for Python packages with: .. code-block:: console - ./setup.py install + ./setup.py install --user -This is equivalent to what the ``pip`` installer does. It puts novelWriter in the location on your -system where Python packages are usually kept. This is not really the best suited location for a -GUI application like novelWriter, so you may instead copy the entire source to a suiteable location -yourself. +This requires that the package ``setuptools`` is installed on your system. If not, it can be +installed with: + +.. code-block:: console + + pip3 install --user setuptools + +This is method of install is equivalent to what the ``pip`` installer does. It puts novelWriter in +the location on your system where Python packages are usually kept. This is not really the best +suited location for a GUI application like novelWriter, so you may instead copy the entire source +to a suiteable location yourself. After this, you should be able to launch novelWriter by running ``novelWriter`` in a command line window.