From 3b96e949925e14d09e90b4da0c8f95bacfbca5d3 Mon Sep 17 00:00:00 2001 From: palmtree5 <3577255+palmtree5@users.noreply.github.com> Date: Sun, 22 Oct 2017 16:40:12 -0800 Subject: [PATCH] [V3 Docs] fix install commands (#1043) * [Docs] fix install commands * [Docs] update with option of installing from github --- docs/install_centos.rst | 16 +++++++++++++++- docs/install_debian.rst | 12 ++++++++++-- docs/install_mac.rst | 16 +++++++++++++++- docs/install_raspbian.rst | 16 +++++++++++++++- docs/install_ubuntu.rst | 12 ++++++++++-- docs/install_windows.rst | 6 ++++-- 6 files changed, 69 insertions(+), 9 deletions(-) diff --git a/docs/install_centos.rst b/docs/install_centos.rst index 623a332e2..9e4b1ebd5 100644 --- a/docs/install_centos.rst +++ b/docs/install_centos.rst @@ -19,7 +19,21 @@ Installing pre-requirements Installing Red -------------- -:code:`pip3 install red-discordbot[voice]` +Without audio: + +:code:`pip3 install -U --process-dependency-links red-discordbot` + +With audio: + +:code:`pip3 install -U --process-dependency-links red-discordbot[voice]` + +To install the development version (without audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot` + +To install the development version (with audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]` ---------------------- Setting up an instance diff --git a/docs/install_debian.rst b/docs/install_debian.rst index d26974109..09b535c31 100644 --- a/docs/install_debian.rst +++ b/docs/install_debian.rst @@ -22,11 +22,19 @@ Installing the bot To install without audio: -:code:`pip3 install red-discordbot` +:code:`pip3 install -U --process-dependency-links red-discordbot` To install with audio: -:code:`pip3 install red-discordbot[voice]` +:code:`pip3 install -U --process-dependency-links red-discordbot[voice]` + +To install the development version (without audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot` + +To install the development version (with audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]` ------------------------ Setting up your instance diff --git a/docs/install_mac.rst b/docs/install_mac.rst index 1b695586f..b4eaf2eee 100644 --- a/docs/install_mac.rst +++ b/docs/install_mac.rst @@ -22,7 +22,21 @@ Installing pre-requirements Installing Red -------------- -To install Red, run :code:`pip3 install red-discordbot[voice]` +Without audio: + +:code:`pip3 install -U --process-dependency-links red-discordbot` + +With audio: + +:code:`pip3 install -U --process-dependency-links red-discordbot[voice]` + +To install the development version (without audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot` + +To install the development version (with audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]` ---------------------- Setting up an instance diff --git a/docs/install_raspbian.rst b/docs/install_raspbian.rst index 61029f8cc..d20099f92 100644 --- a/docs/install_raspbian.rst +++ b/docs/install_raspbian.rst @@ -16,7 +16,21 @@ Installing pre-requirements Installing Red -------------- -:code:`pip3 install red-discordbot[voice]` +Without audio: + +:code:`pip3 install -U --process-dependency-links red-discordbot` + +With audio: + +:code:`pip3 install -U --process-dependency-links red-discordbot[voice]` + +To install the development version (without audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot` + +To install the development version (with audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]` ---------------------- Setting up an instance diff --git a/docs/install_ubuntu.rst b/docs/install_ubuntu.rst index 6eb1593cd..6449de66a 100644 --- a/docs/install_ubuntu.rst +++ b/docs/install_ubuntu.rst @@ -20,11 +20,19 @@ Installing the bot To install without audio: -:code:`pip3 install red-discordbot` +:code:`pip3 install -U --process-dependency-links red-discordbot` To install with audio: -:code:`pip3 install red-discordbot[voice]` +:code:`pip3 install -U --process-dependency-links red-discordbot[voice]` + +To install the development version (without audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot` + +To install the development version (with audio): + +:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]` ------------------------ Setting up your instance diff --git a/docs/install_windows.rst b/docs/install_windows.rst index 9ec0b49e2..b0a3422a8 100644 --- a/docs/install_windows.rst +++ b/docs/install_windows.rst @@ -28,8 +28,10 @@ Installing Red 1. Open a command prompt (open Start, search for "command prompt", then click it) 2. Run the appropriate command, depending on if you want audio or not - * No audio: :code:`python -m pip install Red-DiscordBot` - * Audio: :code:`python -m pip install Red-DiscordBot[voice]` + * No audio: :code:`python -m pip install -U --process-dependency-links Red-DiscordBot` + * Audio: :code:`python -m pip install -U --process-dependency-links Red-DiscordBot[voice]` + * Development version (without audio): :code:`python -m pip install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot` + * Development version (with audio): :code:`python -m pip install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]` 3. Once that has completed, run :code:`redbot-setup` to set up your instance