[V3 Docs] fix install commands (#1043)

* [Docs] fix install commands

* [Docs] update with option of installing from github
This commit is contained in:
palmtree5 2017-10-22 16:40:12 -08:00 committed by Will
parent 5d48e6f3b1
commit 3b96e94992
6 changed files with 69 additions and 9 deletions

View File

@ -19,7 +19,21 @@ Installing pre-requirements
Installing Red 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 Setting up an instance

View File

@ -22,11 +22,19 @@ Installing the bot
To install without audio: To install without audio:
:code:`pip3 install red-discordbot` :code:`pip3 install -U --process-dependency-links red-discordbot`
To install with audio: 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 Setting up your instance

View File

@ -22,7 +22,21 @@ Installing pre-requirements
Installing Red 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 Setting up an instance

View File

@ -16,7 +16,21 @@ Installing pre-requirements
Installing Red 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 Setting up an instance

View File

@ -20,11 +20,19 @@ Installing the bot
To install without audio: To install without audio:
:code:`pip3 install red-discordbot` :code:`pip3 install -U --process-dependency-links red-discordbot`
To install with audio: 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 Setting up your instance

View File

@ -28,8 +28,10 @@ Installing Red
1. Open a command prompt (open Start, search for "command prompt", then click it) 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 2. Run the appropriate command, depending on if you want audio or not
* No audio: :code:`python -m pip install Red-DiscordBot` * No audio: :code:`python -m pip install -U --process-dependency-links Red-DiscordBot`
* Audio: :code:`python -m pip install Red-DiscordBot[voice]` * 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 3. Once that has completed, run :code:`redbot-setup` to set up your instance