From 6f845745115a85936115ffbc219f47aa6f339d87 Mon Sep 17 00:00:00 2001
From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com>
Date: Sat, 23 Jan 2021 12:12:45 +0100
Subject: [PATCH] Also updated docs

---
 CONTRIBUTING.md             |  2 +-
 docs/source/int_started.rst | 28 ++++++++++++++++++++++++++--
 2 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2a87df97..127ede62 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -72,7 +72,7 @@ not conform to the standard.
 
 ## Ignored Errors
 
-Some errors are ignored in novelWriter, for various reasons. In addition, novelWriter uses
+Some `flake8` error codes are ignored for this project for various reasons. The source also uses
 camelCase function and variable names due to this being the standard for the Qt libraries, and also
 because of the author's personal preferences.
 
diff --git a/docs/source/int_started.rst b/docs/source/int_started.rst
index b3037537..9da44533 100644
--- a/docs/source/int_started.rst
+++ b/docs/source/int_started.rst
@@ -32,7 +32,8 @@ in principle work fine on other operating systems as long as dependencies are me
 
 You can download the latest version of novelWriter from the source repository on GitHub_.
 novelWriter is also hosted on PyPi_, and can be installed on all operating systems that support Qt5
-and Python 3. It is regularly tested on Linux, Windows and macOS.
+and Python 3. It is regularly tested on Linux, Windows and macOS. The latest version of novelWriter
+is |release|.
 
 To install from PyPi you must first have the ``python`` and ``pip`` commands available on your
 system. If you don't, see specific instructions for your operating system later in this document.
@@ -48,7 +49,14 @@ To upgrade an existing installation, use:
 
    pip install --upgrade novelwriter
 
-The latest version of novelWriter is |release|.
+When installing via pip, novelWriter can be launched from command line with:
+
+.. code-block:: console
+
+   novelWriter
+
+Make sure the install location for pip is in your PATH variable. This is not always the case by
+default.
 
 .. _GitHub: https://github.com/vkbo/novelWriter/releases
 .. _PyPi: https://pypi.org/project/novelWriter/
@@ -138,6 +146,9 @@ By default, these commands install novelWriter and its icons for the current use
 for all users, run the script with the ``sudo`` command. Other options are also available. Run
 ``python setup.py help`` for a full list of install options.
 
+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.
+
 
 .. _a_started_macos:
 
@@ -160,6 +171,19 @@ dictionaries.
 
    brew install enchant
 
+With the dependencies in place, you can either launch the ``novelWriter.py`` script directly, or
+run the install command:
+
+.. code-block:: console
+
+   python setup.py install
+
+After this, you should be able to launch novelWriter by running ``novelWriter`` in a command line
+window.
+
+Right now there isn't a better integration with macOS available. Contributions from someone more
+familiar with macOS would be very much appreciated.
+
 .. _brew docs: https://docs.brew.sh/Homebrew-and-Python