From 7eed033c9e0f7588ad8e6cc14505c5f50453ed14 Mon Sep 17 00:00:00 2001 From: Toby Harradine Date: Thu, 6 Sep 2018 21:53:18 +1000 Subject: [PATCH] Prettify README and translate to MarkDown (#2101) Signed-off-by: Redjumpman --- MANIFEST.in | 2 +- README.md | 135 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 113 ------------------------------------------- setup.cfg | 3 +- 4 files changed, 138 insertions(+), 115 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/MANIFEST.in b/MANIFEST.in index 589fc14fd..0f59a790e 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ -include README.rst +include README.md include LICENSE include dependency_links.txt diff --git a/README.md b/README.md new file mode 100644 index 000000000..303c5decc --- /dev/null +++ b/README.md @@ -0,0 +1,135 @@ +

+
+ Red - Discord Bot +
+ Red Discord Bot +
+

+ +

Music, Moderation, Trivia, Stream Alerts and Fully Modular.

+ +

+ + Discord Server + + + Support Red on Patreon! + + + Made with Python 3 + + + Localized with Crowdin + + + discord.py + +

+

+ + Travis CI + + + Red on readthedocs.org + + + Code Style: Black + + + + +

+ +

+ Overview + • + Installation + • + Documentation + • + Plugins + • + Community + • + License +

+ +# Overview + +Red is a fully modular bot – meaning all features and commands can be enabled/disabled to your +liking, making it completely customizable. This is also a *self-hosted bot* – meaning you will need +to host and maintain your own instance. You can turn Red into an admin bot, music bot, trivia bot, +new best friend or all of these together! + +[Installation](#installation) is easy, and you do **NOT** need to know anything about coding! Aside +from installation and updating, every part of the bot can be controlled from within Discord. + +**The default set of modules includes and is not limited to:** + +- Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup) +- Trivia (lists are included and can be easily added) +- Music features (YouTube, SoundCloud, local files, playlists, queues) +- Stream alerts (Twitch, Youtube, Mixer, Hitbox, Picarto) +- Bank (slot machine, user credits) +- Custom commands +- Imgur/gif search +- Admin automation (self-role assignment, cross-server announcements, mod-mail reports) +- Customisable command permissions + +**Additionally, other [plugins](#plugins) (cogs) can be easily found and added from our growing +community of cog repositories.** + +# Installation + +**The following platforms are officially supported:** + +- [Windows](https://red-discordbot.readthedocs.io/en/v3-develop/install_windows.html) +- [MacOS](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html) +- [Ubuntu](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html) +- [Debian Stretch](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html) +- [CentOS 7](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html) +- [Arch Linux](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html) +- [Raspbian Stretch](https://red-discordbot.readthedocs.io/en/v3-develop/install_linux_mac.html) + +Already using **Red** V2? Take a look at the [Data Converter](https://red-discordbot.readthedocs.io/en/v3-develop/cog_dataconverter.html) +to import your data to V3. + +If after reading the guide you are still experiencing issues, feel free to join the +[Official Discord Server](https://discord.gg/red) and ask in the **#v3-support** channel for help. + +# Plugins + +Red is fully modular, allowing you to load and unload plugins of your choice, and install 3rd party +plugins directly from Discord! A few examples are: + +- Cleverbot integration (talk to Red and she talks back) +- Ban sync +- Welcome messages +- Casino +- Reaction roles +- Slow Mode +- Anilist +- And much, much more! + +Feel free to take a [peek](https://github.com/Cog-Creators/Red-DiscordBot/issues/1398) at a list of +available 3rd party cogs! + +# Join the community! + +**Red** is in continuous development, and it’s supported by an active community which produces new +content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t +[find](https://github.com/Cog-Creators/Red-DiscordBot/issues/1398) the cog you’re looking for, +consult our [guide](https://red-discordbot.readthedocs.io/en/v3-develop/guide_cog_creation.html) on +building your own cogs! + +Join us on our [Official Discord Server](https://discord.gg/red)! + +# License + +Released under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) license. + +Red is named after the main character of "Transistor", a video game by +[Super Giant Games](https://www.supergiantgames.com/games/transistor/). + +Artwork created by [Sinlaire](https://sinlaire.deviantart.com/) on Deviant Art for the Red Discord +Bot Project. diff --git a/README.rst b/README.rst deleted file mode 100644 index 496a5ff7a..000000000 --- a/README.rst +++ /dev/null @@ -1,113 +0,0 @@ -.. class:: center - - .. image:: https://imgur.com/pY1WUFX.png - :target: https://github.com/Cog-Creators/Red-DiscordBot/tree/V3/develop - :alt: Red Discord Bot - - -.. class:: center - - Music, Moderation, Trivia, Stream Alerts and fully customizable. - -.. class:: center - - .. image:: https://discordapp.com/api/guilds/133049272517001216/embed.png - :target: https://discord.gg/red - :alt: Discord server - - .. image:: https://api.travis-ci.org/Cog-Creators/Red-DiscordBot.svg?branch=V3/develop - :target: https://travis-ci.org/Cog-Creators/Red-DiscordBot - :alt: Travis CI status - - .. 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/discord-py-blue.svg - :target: https://github.com/Rapptz/discord.py - :alt: discord.py - - .. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/ambv/black - :alt: Code style: black - - .. 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/PRs-welcome-brightgreen.svg - :target: http://makeapullrequest.com - :alt: PRs open - -========== -Overview -========== - -Red is a fully modular bot – meaning all features and commands can be enabled/disabled to your liking, making it completely customizable. -This is also a *self-hosted bot* – meaning you will need to host and maintain your own instance. You can turn Red into an admin bot, music bot, trivia bot, new best friend or all of these together! - -`Installation <#installation>`_ is easy, and you do **NOT** need to know anything about coding! Aside from installation and updating, every part of the bot can be controlled from within Discord. - -**The default set of modules includes and is not limited to:** - -- Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup) -- Trivia (lists are included and can be easily added) -- Music features (YouTube, SoundCloud, local files, playlists, queues) -- Stream alerts (Twitch, Youtube, Mixer, Hitbox, Picarto) -- Slot machine -- Custom commands -- Imgur/gif search - - -**Additionally, other plugins (cogs) can be easily found and added from our growing community of cog repositories.** - -- Cleverbot integration (talk to Red and she talks back) -- Ban sync -- Welcome messages -- Casino -- Reaction roles -- Slow Mode -- Anilist -- And much, much more! - -Feel free to take a `peek `_! - -============== -Installation -============== - -**The following platforms are officially supported:** - -- `Windows `_ -- `MacOS `_ -- `Ubuntu `_ -- `Debian Stretch `_ -- `CentOS 7 `_ -- `Arch Linux `_ -- `Raspbian Stretch `_ - -Already using **Red** V2? Take a look at the `Data Converter `_ to import your data to V3. - -If `after reading the guides `_ you are still experiencing issues, feel free to join the `Official Server `_ and ask in the **#support** channel for help. - -===================== -Join the community! -===================== - -**Red** is in continuous development, and it’s supported by an active community which produces new content (cogs/plugins) for everyone to enjoy. New features are constantly added. If you can’t `find `_ what you’re looking for, consult our `guide `_ on building your own cogs! - -Join us on our `Official Discord Server `_! - -========= -License -========= - -Released under the `GNU GPL v3 <#License>`_. - -Red is named after the main character of "Transistor", a videogame by `Super Giant Games `_ - -Artwork created by `Sinlaire `_ on Deviant Art for the Red Bot Project. diff --git a/setup.cfg b/setup.cfg index 7c9518073..e9e665059 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,2 +1,3 @@ [metadata] -long_description = file: README.rst \ No newline at end of file +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM