Browse Source

updating the readme to be a lil better, adding front matter to a lot of the docs, and moving installation information to its own page.

tags/v2.0.0
Roxie Gibson 5 years ago
parent
commit
890a83594b
6 changed files with 93 additions and 112 deletions
  1. +11
    -56
      README.md
  2. +0
    -0
      docs/contributing.md
  3. +17
    -55
      docs/index.md
  4. +56
    -0
      docs/installation/linux.md
  5. +7
    -0
      docs/trivia.md
  6. +2
    -1
      mkdocs.yml

+ 11
- 56
README.md View File

@@ -1,74 +1,29 @@
# Roxbot

[![Banner](http://i.imgur.com/SZIVXEg.png)](https://github.com/Roxxers)

[![Python](https://img.shields.io/badge/Python-3.5%2B-blue.svg?style=flat-square)](https://gitlab.roxxers.xyz/roxxers/roxbot)
[![MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://gitlab.roxxers.xyz/roxxers/roxbot/blob/master/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[<img src="https://discordapp.com/api/guilds/450805414024577035/widget.png?style=shield">](https://discord.gg/Mpz8nv7)
[![MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge&maxAge=300)](https://gitlab.roxxers.xyz/roxxers/roxbot/blob/master/LICENSE)
[![Python](https://img.shields.io/badge/Python-3.5%2B-blue.svg?style=for-the-badge&maxAge=300)](https://gitlab.roxxers.xyz/roxxers/roxbot)
![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/roxxers/roxbot.svg?style=for-the-badge)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge&maxAge=300)](http://makeapullrequest.com)
[![Roxbot Discord Server](https://img.shields.io/discord/450805414024577035.svg?logo=discord&style=for-the-badge&maxAge=300)](https://discord.gg/Mpz8nv7)

Roxbot: An inclusive modular multi-purpose Discord bot. Built with love (and discord.py) by Roxxers#7443.
An inclusive modular multi-purpose Discord bot. Built with love (and discord.py) by Roxxers#7443.

Roxbot is designed to be provide many different services for users and moderators alike with a focus on customisability. Roxbot also has a focus on being inclusive and being fun for all kinds of people. Roxbot is a bot written by a queer woman with the lgbt community in mind.


[Changelog](https://github.com/Roxxers/roxbot/blob/master/CHANGELOG.md) - [Docs](https://roxxers.github.io/roxbot/) - [Command Docs](https://roxxers.github.io/roxbot/commands/)

## Don't want to run Roxbot yourself?

## Quick Setup

Roxbot has only been tested on Linux machines so far so these instructions are written for Linux users.

Requirements:

- Python 3.5 or higher
- Pip (to install dependencies)
- A Discord bot account ([How to make a bot account](https://discordpy.readthedocs.io/en/rewrite/discord.html#creating-a-bot-account))

Optional Requirements:

- Imgur API client ID (for Reddit cog. Create a application to gain access to the Imgur API [here](https://api.imgur.com/oauth2/addclient))
- ffmpeg (for Voice cog [music bot])
- libopus (for Voice cog [music bot])

If you don't meet the requirements for a cog, be sure to comment out that cog in the `roxbot/__init__.py` file.
A version of Roxbot hosted by me can be invited to your server now via [this link.](https://discordapp.com/oauth2/authorize?client_id=259869304369971200&scope=bot&permissions=871890001)

1. Clone Roxbot to your system

```bash
$ git clone https://github.com/roxxers/roxbot.git
$ cd roxbot/
```

2. Create a venv for Roxbot

```bash
$ python3 -m venv ./env
$ source env/bin/activate # For bash and zsh users
$ source env/bin/activate.fish # For fish users
```
3. Install Python dependencies

```bash
$ python3 -m pip install -r requirements.txt
```

4. Edit Roxbot's config to add your bot accounts token (and Imgur api token if you plan to use the Reddit cog) to the config, and also edit some other config settings. Then rename it so that Roxbot will be able to read it.

```bash
$ nano roxbot/settings/roxbot_example.conf
$ mv roxbot/settings/roxbot_example.conf roxbot/settings/roxbot.conf
```
5. Run Roxbot and she should setup everything if you haven't run her before.
## Want to run Roxbot yourself?

```bash
$ ./roxbot.py
```
Find out how to install Roxbot to your Linux machine [here](https://roxxers.github.io/roxbot/installation/linux/)!
## Need Support?

If you want Roxbot support, a support Discord can be found by clicking the Discord banner at the top of the readme,
If you want Roxbot support, a support Discord can be found by clicking the Discord banner at the top of the readme or clicking [here](https://discord.gg/Mpz8nv7),

## Support Me <small>If you want/can</small>


+ 0
- 0
docs/contributing.md View File


+ 17
- 55
docs/index.md View File

@@ -1,74 +1,36 @@
# Roxbot
---
title: Roxbot
description: Roxbot's Documentation.
authors:
- Roxanne Gibson
---

[![Banner](http://i.imgur.com/SZIVXEg.png)](https://github.com/Roxxers)

[![Python](https://img.shields.io/badge/Python-3.5%2B-blue.svg?style=flat-square)](https://gitlab.roxxers.xyz/roxxers/roxbot)
[![MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://gitlab.roxxers.xyz/roxxers/roxbot/blob/master/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[<img src="https://discordapp.com/api/guilds/450805414024577035/widget.png?style=shield">](https://discord.gg/Mpz8nv7)
[![MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge&maxAge=300)](https://gitlab.roxxers.xyz/roxxers/roxbot/blob/master/LICENSE)
[![Python](https://img.shields.io/badge/Python-3.5%2B-blue.svg?style=for-the-badge&maxAge=300)](https://gitlab.roxxers.xyz/roxxers/roxbot)
![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/roxxers/roxbot.svg?style=for-the-badge)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge&maxAge=300)](http://makeapullrequest.com)
[![Roxbot Discord Server](https://img.shields.io/discord/450805414024577035.svg?logo=discord&style=for-the-badge&maxAge=300)](https://discord.gg/Mpz8nv7)

Roxbot: An inclusive modular multi-purpose Discord bot. Built with love (and discord.py) by Roxxers#7443.
An inclusive modular multi-purpose Discord bot. Built with love (and discord.py) by Roxxers#7443.

Roxbot is designed to be provide many different services for users and moderators alike with a focus on customisability. Roxbot also has a focus on being inclusive and being fun for all kinds of people. Roxbot is a bot written by a queer woman with the lgbt community in mind.


[Changelog](https://github.com/Roxxers/roxbot/blob/master/CHANGELOG.md) - [Docs](https://roxxers.github.io/roxbot/) - [Command Docs](https://roxxers.github.io/roxbot/commands/)

## Don't want to run Roxbot yourself?

## Quick Setup
A version of Roxbot hosted by me can be invited to your server now via [this link.](https://discordapp.com/oauth2/authorize?client_id=259869304369971200&scope=bot&permissions=871890001)

Roxbot has only been tested on Linux machines so far so these instructions are written for Linux users.
## Want to run Roxbot yourself?

Requirements:

- Python 3.5 or higher
- Pip (to install dependencies)
- A Discord bot account ([How to make a bot account](https://discordpy.readthedocs.io/en/rewrite/discord.html#creating-a-bot-account))

Optional Requirements:

- Imgur API client ID (for Reddit cog. Create a application to gain access to the Imgur API [here](https://api.imgur.com/oauth2/addclient))
- ffmpeg (for Voice cog [music bot])
- libopus (for Voice cog [music bot])

If you don't meet the requirements for a cog, be sure to comment out that cog in the `roxbot/__init__.py` file.

1. Clone Roxbot to your system

```bash
$ git clone https://github.com/roxxers/roxbot.git
$ cd roxbot/
```

2. Create a venv for Roxbot

```bash
$ python3 -m venv ./env
$ source env/bin/activate # For bash and zsh users
$ source env/bin/activate.fish # For fish users
```
3. Install Python dependencies

```bash
$ python3 -m pip install -r requirements.txt
```

4. Edit Roxbot's config to add your bot accounts token (and Imgur api token if you plan to use the Reddit cog) to the config, and also edit some other config settings. Then rename it so that Roxbot will be able to read it.

```bash
$ nano roxbot/settings/roxbot_example.conf
$ mv roxbot/settings/roxbot_example.conf roxbot/settings/roxbot.conf
```
5. Run Roxbot and she should setup everything if you haven't run her before.

```bash
$ ./roxbot.py
```
Find out how to install Roxbot to your Linux machine [here](https://roxxers.github.io/roxbot/installation/linux/)!
## Need Support?

If you want Roxbot support, a support Discord can be found by clicking the Discord banner at the top of the readme,
If you want Roxbot support, a support Discord can be found by clicking the Discord banner at the top of the readme or clicking [here](https://discord.gg/Mpz8nv7),

## Support Me <small>If you want/can</small>


+ 56
- 0
docs/installation/linux.md View File

@@ -0,0 +1,56 @@
---
title: Linux Installation
description: Guide to installing Roxbot on Linux.
authors:
- Roxanne Gibson
---


# Linux Installation

Requirements:

- Python 3.5 or higher
- Pip (to install dependencies)
- A Discord bot account ([How to make a bot account](https://discordpy.readthedocs.io/en/rewrite/discord.html#creating-a-bot-account))

Optional Requirements:

- Imgur API client ID (for Reddit cog. Create a application to gain access to the Imgur API [here](https://api.imgur.com/oauth2/addclient))
- ffmpeg (for Voice cog [music bot])
- libopus (for Voice cog [music bot])

If you don't meet the requirements for a cog, be sure to comment out that cog in the `roxbot/__init__.py` file.

1. Clone Roxbot to your system

```bash
$ git clone https://github.com/roxxers/roxbot.git
$ cd roxbot/
```

2. Create a venv for Roxbot

```bash
$ python3 -m venv ./env
$ source env/bin/activate # For bash and zsh users
$ source env/bin/activate.fish # For fish users
```
3. Install Python dependencies

```bash
$ python3 -m pip install -r requirements.txt
```

4. Edit Roxbot's config to add your bot accounts token (and Imgur api token if you plan to use the Reddit cog) to the config, and also edit some other config settings. Then rename it so that Roxbot will be able to read it.

```bash
$ nano roxbot/settings/roxbot_example.conf
$ mv roxbot/settings/roxbot_example.conf roxbot/settings/roxbot.conf
```
5. Run Roxbot and she should setup everything if you haven't run her before.

```bash
$ ./roxbot.py
```

+ 7
- 0
docs/trivia.md View File

@@ -1,3 +1,10 @@
---
title: Roxbot Trivia
description: About Roxbot's trivia game, Roxbot Trivia.
authors:
- Roxanne Gibson
---

# Roxbot Trivia

![roxbottrivialogo](assets/images/roxbottriviabanner.png)

+ 2
- 1
mkdocs.yml View File

@@ -37,7 +37,8 @@ nav:
- User Guide:
- 'Command Docs': 'commands.md'
- 'About Roxbot Trivia': 'trivia.md'
- Installation:
- 'Linux Installation': 'installation/linux.md'
- Setup Roxbot:
- 'Configuring Roxbot': 'config.md'
- 'Creating Cogs For Roxbot': 'creating_cogs.md'

Loading…
Cancel
Save