From 125a92f5d7c799121e571196741f384ba81a36d3 Mon Sep 17 00:00:00 2001 From: "Gregory M. Chorak, PhD" <101673536+DrDoom-EvoGen@users.noreply.github.com> Date: Wed, 4 Sep 2024 13:31:43 -0600 Subject: [PATCH] Update installation.rst Added warnings for Windows install --- docs/users_guide/installation.rst | 34 ++++++++++++++++--------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/users_guide/installation.rst b/docs/users_guide/installation.rst index 909cb75..4c455c0 100644 --- a/docs/users_guide/installation.rst +++ b/docs/users_guide/installation.rst @@ -1,6 +1,6 @@ Installation ============ -Granny was built using Python3 and can be run on any modern operating system including Windows, variants of Linux and OS X. Currently to install Granny, you must use the command-line interface. Follow the installation instructions that match the operating system you are using. +Granny was built using Python3 and can be run on any modern operating system including variants of Linux, OS X, and potentially Windows. Currently to install Granny, you must use the command-line interface. Follow the installation instructions that match the operating system you are using. Opening the terminal @@ -18,13 +18,6 @@ Search for "terminal" in the search box that appears. Click the icon with the t Within the terminal you can type the commands to install Granny. - -Windows Terminal -```````````````` -.. note:: - - Instructions will be added here. - Mac OS X Terminal ````````````````` @@ -33,6 +26,14 @@ Mac OS X Terminal Follow the same instructions as Linux: Ubuntu 22.04. Install the Most Recent Release + +Windows Terminal +```````````````` +.. warning:: + + We do not currently support Granny for Windows. + + ------------------------------- Ubuntu 22.04 Installation @@ -51,14 +52,6 @@ You will see output printed to the terminal as the installation progresses. If s Successfully installed granny-1.0a0 -Windows Installation -````````````````````` - -.. note:: - - Instructions will be added here. - - Mac OS X Installation ````````````````````` @@ -76,6 +69,15 @@ You will see output printed to the terminal as the installation progresses. If s Successfully installed granny-1.0a0 +Windows Installation +````````````````````` + +.. warning:: + + There is currently a dependency missing for Granny to run in Windows and we encourage users of Granny to use a Linux or OS X computer to use Granny. You are welcome to try Granny on Windows but we will not currently offer support for this operating system. + + + Install the Development Version ------------------------------- For most users, the development version of Granny should not be used. This is where leading-edge code is housed before it gets added to a release version. However, if you would like to explore using the development version, perhaps to test new features, you can install following these instructions.