Skip to content

Commit

Permalink
An update to Windows docs structure for our beloved users! (#3894)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackenmen authored Jun 11, 2020
1 parent 6c048fa commit 6c56e47
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 13 deletions.
34 changes: 25 additions & 9 deletions docs/install_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,29 @@
Installing Red on Windows
=========================

---------------
Needed Software
---------------
-------------------------------
Installing the pre-requirements
-------------------------------

The following software dependencies can all be installed quickly and easily through PowerShell,
using a trusted package manager for Windows called `Chocolatey <https://chocolatey.org>`_
Please install the pre-requirements by following instructions from one of the following subsections.

We also provide instructions for manually installing all of the dependencies.
The pre-requirements are:
- Python 3.8.1 or greater
- Pip 18.1 or greater
- Git 2.11+
- Java Runtime Environment 11 (for audio support)

******************************************
Installing using powershell and chocolatey
******************************************
We also recommend installing some basic compiler tools, in case our dependencies don't provide
pre-built "wheels" for your architecture.

.. contents:: Choose a method of installing pre-requirements:
:local:

----

*********************************************
Using PowerShell and Chocolatey (recommended)
*********************************************

To install via PowerShell, search "powershell" in the Windows start menu,
right-click on it and then click "Run as administrator"
Expand All @@ -39,6 +50,8 @@ For Audio support, you should also run the following command before exiting:
From here, exit the prompt then continue onto `creating-venv-windows`.

----

********************************
Manually installing dependencies
********************************
Expand All @@ -61,6 +74,9 @@ Manually installing dependencies

* `Java 11 <https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot>`_ - needed for Audio

From here, continue onto `creating-venv-windows`.

----

.. _creating-venv-windows:

Expand Down
5 changes: 1 addition & 4 deletions docs/update_red.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,11 @@ Here are some things to consider to help make your upgrade as smooth as possible

Updating differs depending on the version you currently have. Next sections will explain how to upgrade to latest version of Red (|version|) from the version that is in the header of the section.

**Choose the version you're currently on from the list below:**

.. contents::
.. contents:: Choose the version you're currently on from the list below:
:local:
:depth: 1



Red 3.2.0 or newer
******************

Expand Down

0 comments on commit 6c56e47

Please sign in to comment.