From 6032f52798ebe7be08bb599d6a8fa74fe5bab392 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Wed, 3 Feb 2021 16:59:07 +0100 Subject: [PATCH] Update documentation --- docs/source/index.rst | 6 +- docs/source/int_windows.rst | 91 ------------------- .../source/{int_linux.rst => setup_linux.rst} | 0 docs/source/{int_mac.rst => setup_mac.rst} | 0 docs/source/setup_windows.rst | 91 +++++++++++++++++++ 5 files changed, 94 insertions(+), 94 deletions(-) delete mode 100644 docs/source/int_windows.rst rename docs/source/{int_linux.rst => setup_linux.rst} (100%) rename docs/source/{int_mac.rst => setup_mac.rst} (100%) create mode 100644 docs/source/setup_windows.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 41c485dd..d5e1bc77 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -61,9 +61,9 @@ details. int_introduction int_started - int_linux - int_mac - int_windows + setup_linux + setup_mac + setup_windows .. toctree:: diff --git a/docs/source/int_windows.rst b/docs/source/int_windows.rst deleted file mode 100644 index 4b2e164c..00000000 --- a/docs/source/int_windows.rst +++ /dev/null @@ -1,91 +0,0 @@ -.. _a_setup_win: - -**************** -Setup on Windows -**************** - -.. _GitHub: https://github.com/vkbo/novelWriter/releases -.. _main website: https://novelwriter.io -.. _zipapp: https://docs.python.org/3/library/zipapp.html -.. _Inno Setup: https://jrsoftware.org/isinfo.php -.. _python.org: https://www.python.org/downloads/windows -.. _PyPi: https://pypi.org/project/novelWriter -.. _discussions: https://github.com/vkbo/novelWriter/discussions - -This is a brief guide to how you can get novelWriter running on a Windows computer. - -On Windows, you have two options: You can either run from source, or install novelWriter via a -Windows installer. The latter is the simplest, but since novelWriter is a hobby project, the -installer is not signed and downloading and running the installer often triggers warning because -Windows doesn't know whether it's safe or not. - -The installer contains an executable zip of novelWriter, a copy of the three libraries it depends -on, and a copy of the Python run environment. If you're uncomfortable with running this installer, -you can install the components yourself and just run novelWriter directly from the source code. The -Source code can be downloaded as a zip file directly from GitHub_. - - -.. _a_setup_win_installer: - -Using the Installer -=================== - -You can install novelWriter with the Windows installer for 64-bit Windows available on the -`main website`_ and GitHub_ page. This installer bundles all that is needed for novelWriter to run, -including Python and the XML and Qt libraries. When installing novelWriter this way, you don't need -to install any of the dependencies manually. The installer is made with zipapp_ and `Inno Setup`_. - - -.. _a_setup_win_source: - -Running from Source -=================== - -To run novelWriter from source, download the latest source package from the release page on -GitHub_, or if you have git running on your computer, you can also clone the repository. - -The main requirement is that you have Python installed. The dependencies of novelWriter can then be -installed from the Python Package Index, PyPi_. - -Step 1: Installing Python -------------------------- - -If you already have Python installed, you can skip this step. If you don't have it installed, you -can download it from the python.org_ website. novelWriter should work with Python 3.6 or higher, -but it is recommended that you install the latest version of Python. - -Also, make sure you select the "Add Python to PATH" option during installation, otherwise the -``python`` command will not work in the command line window. - -.. image:: images/python_win_install.png - :width: 600 - -Step 2: Dependencies and Icons ------------------------------- - -**Alternative A: By Script** - -Open the folder where you extracted the novelWriter source, and double-click the file named -``win_install`` or ``win_install.bat``. This should open a command line window and run the setup -script to install dependencies and desktop and start menu icons. - -**Alternative B: Command Prompt** - -The above alternative can also be run manually. - -Open the windows command prompt. It can be launched by pressing the :kbd:`Win` key and typing "cmd". -The "Command Prompt" app should then be in the list of applications. - -With the command prompt open, navigate to the folder where you extracted the novelWriter source, -and run the following commands. - -.. code-block:: console - - python setup.py pip - python setup.py win-install - -The first command will install the dependencies on your system, and the second command will create -a desktop icon and a start menu icon. - -That should be all that you need. If you have any problems, you can always open a question on the -project's discussions_ page. This requires a GitHub account. diff --git a/docs/source/int_linux.rst b/docs/source/setup_linux.rst similarity index 100% rename from docs/source/int_linux.rst rename to docs/source/setup_linux.rst diff --git a/docs/source/int_mac.rst b/docs/source/setup_mac.rst similarity index 100% rename from docs/source/int_mac.rst rename to docs/source/setup_mac.rst diff --git a/docs/source/setup_windows.rst b/docs/source/setup_windows.rst new file mode 100644 index 00000000..2f5c7686 --- /dev/null +++ b/docs/source/setup_windows.rst @@ -0,0 +1,91 @@ +.. _a_setup_win: + +**************** +Setup on Windows +**************** + +This is a brief guide to how you can get novelWriter running on a Windows computer. + +Unlike other operating systems, Windows does not come prepared with an environment to run Python +applications, so you must first install Python. After that, running novelWriter is straightfoeward. + +If you have any problems, you can always open a question on the project's discussions_ page. This +requires a GitHub account. + +.. _discussions: https://github.com/vkbo/novelWriter/discussions + + +.. _a_setup_win_installer: + +Using the Installer +=================== + +The installer for Windows is no longer provided. You can still create it yourself if you want to. +It can be generated with the provided `setup.py` script. use the script's `help` command to get +further instructions. + +Please use the "Running from Source" option below instead. + + +.. _a_setup_win_source: + +Running from Source +=================== + +To run novelWriter from source, download the latest source zip file from the release page on +GitHub_ or the `main website`_, or if you have git running on your computer, you can also clone the +repository. + +In order to make novelWriter run on your system, you must first have Python installed (Step 1). +Thereafter, a script will do the rest of the job (Step 2). or you can do it yourself manually. + +.. _GitHub: https://github.com/vkbo/novelWriter/releases +.. _main website: https://novelwriter.io + + +Step 1: Installing Python +------------------------- + +If you already have Python installed, you can skip this step. If you don't have it installed, you +can download it from the python.org_ website. novelWriter should work with Python 3.6 or higher, +but it is recommended that you install the latest version of Python. + +Also, make sure you select the "Add Python to PATH" option during installation, otherwise the +``python`` command will not work in the command line window. + +.. image:: images/python_win_install.png + :width: 600 + +.. _python.org: https://www.python.org/downloads/windows + + +Step 2: Dependencies and Icons +------------------------------ + +**Alternative A: By Script** + +Open the folder where you extracted the novelWriter source, and double-click the file named +``setup_windows`` or ``setup_windows.bat``. This should open a command line window and run the +setup script to install dependencies, and desktop and start menu icons. It will also check that it +can find Python from Step 1. + +**Alternative B: Manual Installation** + +The above alternative can also be run manually. + +Open the windows command prompt. It can be launched by pressing the :kbd:`Win` key and typing "cmd". +The "Command Prompt" app should then be in the list of applications. + +With the command prompt open, navigate to the folder where you extracted the novelWriter source, +and run the following commands: + +.. code-block:: console + + python setup.py pip + python setup.py win-install + +The first command will install the dependencies on your system from the `Python Package Index`_, +and the second command will create a desktop icon and a start menu icon. That should be all that +you need. + +.. _Python Package Index: https://pypi.org/