Red-DiscordBot/README.rst
palmtree5 fc36dae54f [V3] Add voice install option and instructions in README (#979)
* [V3] add voice option to setup.py + instructions in readme

* Fix typo
2017-10-01 13:25:32 -04:00

32 lines
1.1 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
********************
Red - Discord Bot v3
********************
**This is alpha and very much a work in progress. Regular use is not recommended.
There will not be any effort not to break current installations.**
How to install
^^^^^^^^^^^^^^
Using python3 pip::
pip install --process-dependency-links -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop
redbot-setup
redbot <name>
To install requirements for voice::
pip install --process-dependency-links -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]
To install all requirements for docs and tests::
pip install --process-dependency-links -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[test,docs]