diff --git a/README.md b/README.md index bb5e230..7502a69 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ A bot which provides a Trivia game for [Discord](https://discordapp.com/). - ### Adding to a server 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). +### 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 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. | #### 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` 2. Navigate to repository directory: `cd TriviaDiscord` 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` 6. `cmake .` 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}`