From 443d12ab44e0a3e6982bc1a0753c85042c382bbd Mon Sep 17 00:00:00 2001 From: "Christian T. Jacobs" Date: Wed, 5 Jul 2017 23:53:28 +0100 Subject: [PATCH] Updated running instructions. --- README.md | 2 +- docs/source/getting_started.rst | 29 ++++++++++++----------------- 2 files changed, 13 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index cf5fb39..f406a0e 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ PyQSO is a contact logging tool for amateur radio operators. Installation and running ------------------------ -Assuming that the current working directory is PyQSO's base directory (the directory that the `Makefile` is in), PyQSO can be run via the terminal by issuing the following command: +Assuming that the current working directory is PyQSO's base directory (the directory that the `Makefile` is in), PyQSO can be run without installation by issuing the following command in the terminal: python3 bin/pyqso diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index de3c845..ba20b11 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -19,28 +19,23 @@ PyQSO depends on is provided in the ``README.md`` file. Installation and running ------------------------ -Assuming that the current working directory is PyQSO's base directory -(the directory that the ``Makefile`` is in), PyQSO can be installed via the -terminal with the following command: - -.. code-block:: bash - - make install - -Note: ``sudo`` may be needed for this. Once installed, the following -command will run PyQSO: - -.. code-block:: bash - - pyqso - -Alternatively, PyQSO can be run (without installing) with: +Assuming that the current working directory is PyQSO's base directory (the directory that the ``Makefile`` is in), PyQSO can be run without installation by issuing the following command in the terminal: .. code-block:: bash python3 bin/pyqso -from PyQSO's base directory. +If the ``pip3`` package manager is available on your system then PyQSO can be installed using: + +.. code-block:: bash + + make install + +Note that ``sudo`` may also be needed here for system-wide installation. Once installed, the following command will run PyQSO: + +.. code-block:: bash + + pyqso Command-line options ~~~~~~~~~~~~~~~~~~~~