From 37f27d8ae4bc0fc5d2e5373b7d79dc22c3ada6ea Mon Sep 17 00:00:00 2001 From: Vexed <51716387+Vexed01@users.noreply.github.com> Date: Sun, 29 Sep 2019 12:43:53 +0100 Subject: [PATCH] [Docs] Git Install Updates, note about launcher deprecation, capitalise some words (#2998) * commit * add launcher depricate to linix/mac * sorry linux i still ignored you capitalise some linix stuff i couldnt be bothered to do before * remove mentions of launcher & update changelog enrty --- changelog.d/2998.docs.rst | 1 + docs/install_linux_mac.rst | 13 ++----------- docs/install_windows.rst | 16 ++++------------ 3 files changed, 7 insertions(+), 23 deletions(-) create mode 100644 changelog.d/2998.docs.rst diff --git a/changelog.d/2998.docs.rst b/changelog.d/2998.docs.rst new file mode 100644 index 000000000..943d1db01 --- /dev/null +++ b/changelog.d/2998.docs.rst @@ -0,0 +1 @@ +Update Git PATH install (Windows), capitalise some words, don't mention to launcher \ No newline at end of file diff --git a/docs/install_linux_mac.rst b/docs/install_linux_mac.rst index 22a87ee15..ee37d80b2 100644 --- a/docs/install_linux_mac.rst +++ b/docs/install_linux_mac.rst @@ -18,8 +18,8 @@ Please install the pre-requirements using the commands listed for your operating The pre-requirements are: - Python 3.7.0 or greater - - pip 9.0 or greater - - git + - Pip 9.0 or greater + - Git - Java Runtime Environment 8 or later (for audio support) We also recommend installing some basic compiler tools, in case our dependencies don't provide @@ -316,12 +316,3 @@ It will walk through the initial setup, asking for your token and a prefix. You can find out how to obtain a token with `this guide `_, section "Creating a Bot Account". - -You may also run Red via the launcher, which allows you to restart the bot -from discord, and enable auto-restart. You may also update the bot from the -launcher menu. Use the following command to run the launcher: - -.. code-block:: none - - redbot-launcher - diff --git a/docs/install_windows.rst b/docs/install_windows.rst index 76807eab9..6d003ca6f 100644 --- a/docs/install_windows.rst +++ b/docs/install_windows.rst @@ -8,8 +8,8 @@ Installing Red on Windows Needed Software --------------- -The following software dependencies can all be installed quickly and easily through powershell, -using a trusted package manager for windows called `Chocolatey `_ +The following software dependencies can all be installed quickly and easily through PowerShell, +using a trusted package manager for Windows called `Chocolatey `_ We also provide instructions for manually installing all of the dependencies. @@ -17,7 +17,7 @@ We also provide instructions for manually installing all of the dependencies. Installing using powershell and chocolatey ****************************************** -To install via powershell, search "powershell" in the windows start menu, +To install via PowerShell, search "powershell" in the Windows start menu, right-click on it and then click "Run as administrator" Then run each of the following commands: @@ -42,7 +42,7 @@ Manually installing dependencies * `Git `_ -.. attention:: Please choose the option to "Run Git from the Windows Command Prompt" in Git's setup. +.. attention:: Please choose the option to "Git from the command line and also from 3rd-party software" in Git's setup. * `Java `_ - needed for Audio @@ -121,11 +121,3 @@ It will walk through the initial setup, asking for your token and a prefix. You can find out how to obtain a token with `this guide `_, section "Creating a Bot Account". - -You may also run Red via the launcher, which allows you to restart the bot -from discord, and enable auto-restart. You may also update the bot from the -launcher menu. Use the following command to run the launcher: - -.. code-block:: none - - redbot-launcher