Trivia.jl

This package provides a very simple interface to the Open Trivia Database API in Julia. It consists of some helpful methods to retrieve and display trivia questions as well as a simple interactive mode to make it easy to play through a round of questions in a given category.

Installation

Getting Julia

If you don't have Julia installed, you will need to download it from https://julialang.org/downloads/. This package was written using Julia v1.1.1, but any v1.x.y version should be fine.

Installing this package

You can install this package through Julia's built-in package manager, Pkg.

First, start up Julia. You should see the normal Julia prompt:

julia>

Press ] to activate Pkg mode. Your prompt should switch to:

pkg> 

Run the following to install this package:

pkg> add https://github.com/rdeits/Trivia.jl

Usage

Start Julia. If you have the pkg> prompt, press backspace to get back to the normal julia> prompt.

Load this package by running:

julia> using Trivia

And start a round of trivia with:

julia> play_round()

Hacking on this Package

If you want to make changes to this package, the easiest way to do that is to use the Julia package manager to "develop" the package. Start Julia, and press ] to switch to pkg> mode. Then run:

pkg> develop Trivia

This will clone the repository to ~/.julia/dev/Trivia/. You can edit the files there and make commits just like you would with any other git/github project.

Note that by default your changes will not take effect until you restart Julia. To enable automatically updating your code as you edit it, without restarting Julia, check out Revise.jl.

What are all these files?

If you're new to Julia, this section will help explain what all of the various files and folders in this project are doing.

• data: This folder is used to store your opentdb.com token. That token makes it easy to ensure you don't get the same questions over and over.
• src: This is where all of the actual Julia source code goes. The main source file is src/Trivia.jl.
• test: This folder holds the test code. The main test file is test/runtests.jl
• .travis.yml: This file holds configuration information for https://travis-ci.org/rdeits/Trivia.jl, which runs our tests automatically
• LICENSE: The open-source license for this code
• Project.toml: This is the file used by the Julia package manager to describe this package and the packages it depends on
• Readme.md: The file you are looking at right now

If you want to see some examples of usage, check out the test folder; if you want to start changing the code, check out the src folder.