Skip to content

Update installation.rst #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DrDoom-EvoGen merged 1 commit into from
Sep 4, 2024
Merged

Update installation.rst #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 18 additions & 16 deletions docs/users_guide/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
`````````````````

Expand All @@ -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
Expand All @@ -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
`````````````````````

Expand All @@ -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.
Expand Down