mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
b348a879c3
* Remove mentions of alpha version * Update README.rst * Give the option for git build in README
39 lines
1.2 KiB
ReStructuredText
39 lines
1.2 KiB
ReStructuredText
.. image:: https://readthedocs.org/projects/red-discordbot/badge/?version=v3-develop
|
|
:target: http://red-discordbot.readthedocs.io/en/v3-develop/?badge=v3-develop
|
|
:alt: Documentation Status
|
|
|
|
.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
|
|
:target: http://makeapullrequest.com
|
|
:alt: PRs Welcome
|
|
|
|
.. image:: https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg
|
|
:target: https://crowdin.com/project/red-discordbot
|
|
:alt: Crowdin
|
|
|
|
********************
|
|
Red - Discord Bot v3
|
|
********************
|
|
|
|
**This is in beta and very much a work in progress. Regular use is not recommended.
|
|
There will not be any effort made to prevent the breaking of current installations.**
|
|
|
|
How to install
|
|
^^^^^^^^^^^^^^
|
|
|
|
Using python3 pip::
|
|
|
|
pip install --process-dependency-links -U Red-DiscordBot
|
|
redbot-setup
|
|
redbot <name>
|
|
|
|
To install requirements for voice::
|
|
|
|
pip install --process-dependency-links -U Red-DiscordBot[voice]
|
|
|
|
To install all requirements for docs and tests::
|
|
|
|
pip install --process-dependency-links -U Red-DiscordBot[test,docs]
|
|
|
|
For the latest git build, replace ``Red-DiscordBot`` in the above commands with
|
|
``git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop``.
|