Red-DiscordBot

mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00

Go to file

Michael H d3f406a34a [V3 Travis] Update travis to not skip pipfile lock... (#1678 )

* Update travis to not sip pipfile lock

update pipfile dependencies

additional black formatting pass to conform to black 18.5b

* .

* pin async timeout until further discussion of 3.5 support

* .

2018-05-18 17:48:22 -08:00

.github

[V3] move to multiple issue/pr templates (#1585 )

2018-05-04 03:58:30 +02:00

docs

Black formatting for generate_strings.py and docs/conf.py (#1658 )

2018-05-15 09:27:06 +10:00

redbot

[V3 Travis] Update travis to not skip pipfile lock... (#1678 )

2018-05-18 17:48:22 -08:00

tests

[V3 Travis] Update travis to not skip pipfile lock... (#1678 )

2018-05-18 17:48:22 -08:00

.gitignore

[V3] Add .pytest_cache to .gitignore (#1520 )

2018-04-11 14:45:53 -08:00

.readthedocs.yml

[V3 Docs] Modify RTD config to (hopefully) make it build (#1644 )

2018-05-14 15:03:43 +10:00

.travis.yml

[V3 Travis] Update travis to not skip pipfile lock... (#1678 )

2018-05-18 17:48:22 -08:00

crowdin.yml

[V3] add a script for regenerating all strings (#1318 )

2018-02-19 03:02:22 +01:00

generate_strings.py

Black formatting for generate_strings.py and docs/conf.py (#1658 )

2018-05-15 09:27:06 +10:00

LICENSE

[V3] Update year in license (#1242 )

2018-01-09 16:20:05 -09:00

MANIFEST.in

[V3 Audio] Initial V3 addition (#1373 )

2018-03-03 15:42:20 +11:00

Pipfile

[V3] Add tox (#1641 )

2018-05-15 13:10:14 +10:00

Pipfile.lock

[V3 Travis] Update travis to not skip pipfile lock... (#1678 )

2018-05-18 17:48:22 -08:00

README.rst

[V3] Update code standards (black code format pass) (#1650 )

2018-05-14 15:33:24 -04:00

requirements.txt

[V3 Travis] Update travis to not skip pipfile lock... (#1678 )

2018-05-18 17:48:22 -08:00

setup.cfg

[V3 Everything] Package bot and write setup scripts (#964 )

2017-09-08 23:14:32 -04:00

setup.py

[V3 Travis] Update travis to not skip pipfile lock... (#1678 )

2018-05-18 17:48:22 -08:00

tox.ini

[V3] Add tox (#1641 )

2018-05-15 13:10:14 +10:00

README.rst

.. 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
    
.. image:: https://img.shields.io/badge/Support-Red!-orange.svg
    :target: https://www.patreon.com/Red_Devs
    :alt: Patreon

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/ambv/black
    :alt: Code style: black


********************
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``.