jack/Toast
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jack Bond-Preston 2016-08-01 00:59:25 +01:00 committed by GitHub
parent 4caab94bdf
commit 4b51a24968
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,7 +2,6 @@
A bot which provides a Trivia game for [Discord](https://discordapp.com/). A bot which provides a Trivia game for [Discord](https://discordapp.com/).
### Adding to a server ### Adding to a server
You can either self-host trivia-bot, or use the hosted version. You can either self-host trivia-bot, or use the hosted version.
@ -10,6 +9,17 @@ To invite the bot to your server use [this invite link](https://discordapp.com/o
It requires no special permissions at this time (only read/write to channels). It requires no special permissions at this time (only read/write to channels).
### Installation
[Releases](https://github.com/jackb-p/trivia-bot/releases) are available for tagged versions. These are compiled on Ubuntu by Travis CI. To run on other systems you will need to compile yourself - a CMake configuration is included. Windows releases will happen one day.
If you want to install a version for which a release does not exist, you will also have to compile manually. Compilation instructions are available for Linux below.
### Running
To run simply execute the program: `./TriviaBot`
If you do not want to be prompted for your token every launch, provide it as an argument: `./TriviaBot {TOKEN}`
### Trivia Questions ### Trivia Questions
Questions are obtained from [trivia-db on Sourceforge](https://sourceforge.net/projects/triviadb/). Questions are obtained from [trivia-db on Sourceforge](https://sourceforge.net/projects/triviadb/).
@ -40,16 +50,12 @@ LoadDB.cpp takes some time to execute.
| nlohmann/json | [nlohmann/json](https://github.com/nlohmann/json) | (Slightly modified) source file included in repo. | | nlohmann/json | [nlohmann/json](https://github.com/nlohmann/json) | (Slightly modified) source file included in repo. |
#### Linux (debian) #### Linux (debian)
c++14 support is required. gcc 5 and above recommended.
1. Clone the github repo: `git clone https://github.com/jackb-p/TriviaDiscord.git TriviaDiscord` 1. Clone the github repo: `git clone https://github.com/jackb-p/TriviaDiscord.git TriviaDiscord`
2. Navigate to repository directory: `cd TriviaDiscord` 2. Navigate to repository directory: `cd TriviaDiscord`
3. Clone the submodules: `git submodule init` and `git submodule update` 3. Clone the submodules: `git submodule init` and `git submodule update`
4. Install other dependencies: `sudo apt-get install cmake libboost-all-dev libcurl-dev` 4. Install other dependencies: `sudo apt-get install cmake libboost-all-dev libcurl-dev` (Package managers and names may vary, but all of these should be easy to find through a simple Google search.)
5. `cd TriviaBot` 5. `cd TriviaBot`
6. `cmake .` 6. `cmake .`
7. `make` 7. `make`
### Running
To run simply execute the program: `./TriviaBot`
If you do not want to be prompted for your token every launch, provide it as an argument: `./TriviaBot {TOKEN}`