Updated readme and docs

This commit is contained in:
Noikoio 2017-11-19 16:54:39 -08:00
parent 72c9415da9
commit 2a2808ccf2
10 changed files with 32 additions and 19 deletions

View file

@ -2,12 +2,11 @@
RegexBot is a standalone Discord moderation bot that makes use of the
[Discord.Net](https://github.com/RogueException/Discord.Net) library.
The goal of this project is to provide a bot that can truly fit your unique needs in managing Discord server.
To that end, many aspects of the bot's behavior can be configured and fine-tuned, down to how it responds to
rules that you have implemented.
The goal of this project is to provide a bot that can truly fit your unique needs in managing Discord server. To that end, many aspects of the bot's behavior can be configured and fine-tuned, ensuring that the bot acts exactly as you want it to act.
Are you satisfied with your current bot but wish that you could change *that one thing* to better suit your
needs? This project is an answer to that.
Are you satisfied with your current bot but wish that you could change *that one thing* to better suit your needs? This project is an answer to that.
Granted, progress on this project so far has followed the needs of one Discord server that makes heavy use of it, so its current feature set may be limited. Feel free to send a pull request or submit an issue.
## Documentation
Documentation is available in the form of a number of pages hosted by Github Pages. See [this link](https://noikoio.github.com/RegexBot) or the [docs directory](https://github.com/Noikoio/RegexBot/tree/master/docs) for more information.
Documentation is available in the form of a number of pages hosted by Github Pages. See [this site](https://noikoio.github.io/RegexBot) or the [site's source directory](https://github.com/Noikoio/RegexBot/tree/master/docs) for more information.

View file

@ -23,7 +23,7 @@
<li class="fork"><a href="{{ site.github.repository_url }}">View On GitHub</a></li>
<li class="downloads"><a href="{{ site.github.releases_url }}">Releases</a></li>
<li class="title"><a href="{{ site.github.baseurl }}/docs">Documentation</a></li>
<li class="title"><a href="{{ site.github.baseurl }}/docs.html">Documentation</a></li>
</nav>
</div><!-- end header -->

25
docs/docs.md Normal file
View file

@ -0,0 +1,25 @@
# Documentation
**Important note: Documentation is a work in progress and may be incomplete in some areas.**
RegexBot has no default behavior of its own. It is up to the bot operator to define all aspects of its function, down to its triggers and commands to be used by moderators.
Its configuration takes the form of a JSON file residing in the executable directory, named `settings.json`. Within this file should be one nameless JSON object, which itself should contain named values described near the bottom of this page. Additionally, the JSON parser treats text following double slashes as comments.
The following is a sample configuration file:
```
{
"bot-token": "AbCDEf-gh1JKLmn0pqR$Tu.vwXyZ",
"playing": "with my preferred text editor",
"servers": [
{
// (server configuration goes here)
}
]
}
```
The following is a list of all accepted values with links to pages explaining them in more detail.
* bot-token *(string)* - **Required.** Discord token used for connecting to the service.
* playing *(string)* - String to display as the bot's "now playing" status message.
* servers *(array)* - Takes an array of unnamed [server definition](serverdef.html) objects.

View file

@ -1,11 +0,0 @@
# Documentation
On its own, RegexBot has no default behavior. It is up to the user to define everything, including triggers and commands for use by moderators.
Configuration takes the form of a JSON file name `settings.json`. Within this file should be one object, which itself contained named values.
[Sample file for quick reference.](sample.html)
The following is a list of all accepted values with links to pages explaining them in more detail.
* bot-token *(string)* - **Required.** Discord token used for connecting to the service.
* playing *(string)* - String to display as the bot's "now playing" status message.
* servers *(array)* - Takes an array of unnamed [server definition](serverdef.html) objects.

View file

@ -19,7 +19,7 @@ You will need to get a bot token. To do so, [create an app in Discord](https://d
Once you have created your Discord app, go to the following URL after inserting your client ID where specified: `https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID&scope=bot`.
### Configure
When starting or reloading, RegexBot looks for a file in its current directory named `settings.json`. The configuration file is too complex to explain simply here. [Check the documentation](./docs) to find a sample configuration file, as well as more detailed information.
When starting or reloading, RegexBot looks for a file in its current directory named `settings.json`. The configuration file is too complex to explain simply here. [Check the documentation](docs.html) to find a sample configuration file, as well as more detailed information.
# Compiling from source
### Prerequisites