Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Linux setup for consistency and add more details for macOS

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2021-03-21 16:54:53 +01:00
parent 48bbe288b7
commit d4c61e7ec9
2 changed files with 18 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/setup_linux.rst
+6 -6
View File
@@ -42,12 +42,12 @@ can install them with:
Step 2: Install Package (Optional) Step 2: Install Package (Optional)
---------------------------------- ----------------------------------
You can install novelWriter to the default location for Python packages using setuptools. This step You can install novelWriter to the default location for Python packages using ``setuptools``. This
is optional as you can also just put the novelWriter program folder wherever you like. For instance step is optional as you can also just put the novelWriter program folder wherever you like. For
to ``/opt/novelWriter`` and run Step 3 to set up icons and launcher. 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 To install novelWriter to the default location, it requires that you have ``setuptools`` installed
your system. If you don't have setuptools, it can usually be installed from your distro's 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: repository. For Debian and Ubuntu this is achieved with:
.. code-block:: console .. code-block:: console
@@ -60,7 +60,7 @@ The package is also available from PyPi:
pip3 install --user setuptools 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 .. code-block:: console
docs/source/setup_mac.rst
+12 -5
View File
@@ -52,12 +52,19 @@ You can install novelWriter to the correct location for Python packages with:
.. code-block:: console .. 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 This requires that the package ``setuptools`` is installed on your system. If not, it can be
system where Python packages are usually kept. This is not really the best suited location for a installed with:
GUI application like novelWriter, so you may instead copy the entire source to a suiteable location
yourself. .. 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 After this, you should be able to launch novelWriter by running ``novelWriter`` in a command line
window. window.