CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-07 01:42:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

[3.2.0 Docs] Some clarifications (#3292)

Browse Source 
* docs

*  changelog

* Fix python for choco

* k

* little more
This commit is contained in:
Michael H
2020-01-09 10:16:10 -05:00
committed by Kowlin
parent 26677004f1
commit 9698baf6e7
6 changed files with 30 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/guide_cog_creation.rst
View File

@@ -17,7 +17,7 @@ you in the process.
Getting started
---------------
To start off, be sure that you have installed Python 3.7.
To start off, be sure that you have installed Python 3.8.
Next, you need to decide if you want to develop against the Stable or Develop version of Red.
Depending on what your goal is should help determine which version you need.
@@ -26,11 +26,24 @@ Depending on what your goal is should help determine which version you need.
If your goal is to support both versions, make sure you build compatibility layers or use separate branches to keep compatibility until the next Red release
Open a terminal or command prompt and type one of the following
Stable Version: :code:`python3.7 -m pip install -U Red-DiscordBot`
Develop Version: :code:`python3.7 -m pip install -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot`
Stable Version: :code:`python3.8 -m pip install -U Red-DiscordBot`
(Windows users may need to use :code:`py -3.7` or :code:`python` instead of :code:`python3.7`)
.. note::
To install the development version, replace ``Red-DiscordBot`` in the above commands with the
link below. **The development version of the bot contains experimental changes. It is not
intended for normal users.** We will not support anyone using the development version in any
support channels. Using the development version may break third party cogs and not all core
commands may work. Downgrading to stable after installing the development version may cause
data loss, crashes or worse. Please keep this in mind when using the Development version
While working on cog creation.
.. code-block:: none
git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
(Windows users may need to use :code:`py -3.8` or :code:`python` instead of :code:`python3.8`)
--------------------
Setting up a package

12
docs/install_linux_mac.rst
View File

@@ -279,18 +279,6 @@ Or, to install with PostgreSQL support:
python3.8 -m pip install -U setuptools wheel
python3.8 -m pip install -U Red-DiscordBot[postgres]
.. note::
To install the development version, replace ``Red-DiscordBot`` in the above commands with the
link below. **The development version of the bot contains experimental changes. It is not
intended for normal users.** We will not support anyone using the development version in any
support channels. Using the development version may break third party cogs and not all core
commands may work. Downgrading to stable after installing the development version may cause
data loss, crashes or worse.
.. code-block:: none
git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
--------------------------
Setting Up and Running Red

14
docs/install_windows.rst
View File

@@ -28,7 +28,7 @@ Then run each of the following commands:
iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
choco install git --params "/GitOnlyOnPath /WindowsTerminal" -y
choco install visualstudio2019-workload-vctools -y
choco install python3 --version=3.8.1 -y
choco install python3 -y
For Audio support, you should also run the following command before exiting:
@@ -99,18 +99,6 @@ Installing Red
python -m pip install -U setuptools wheel
python -m pip install -U Red-DiscordBot[postgres]
.. note::
To install the development version, replace ``Red-DiscordBot`` in the above commands with the
link below. **The development version of the bot contains experimental changes. It is not
intended for normal users.** We will not support anyone using the development version in any
support channels. Using the development version may break third party cogs and not all core
commands may work. Downgrading to stable after installing the development version may cause
data loss, crashes or worse.
.. code-block:: none
git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=Red-DiscordBot
--------------------------
Setting Up and Running Red