A simple TUI program to help studying.
If you're on Windows or Linux, you can simply download the executable or AppImage from the Releases tab and use that. If you're on MacOS or if you want to have the bleeding-edge releases, you can compile it yourself, like so:
$ git clone https://www.github.com/feistykit/quickstudy
$ cd quickstudy
$ make quickstudy # If you want to not use ncurses, replace `quickstudy` with `no-ncurses`
$ ./quickstudy <input files>
Requires Rust to compile and if you are using ncurses it of course requires ncurses installed to compile. If you want to compile the AppImage (make appimage
), you need linuxdeploy and the linuxdeploy ncurses plugin in your PATH.
Quickstudy takes a series of input files that describe the questions that should be asked, and then asks those questions to the user in the terminal. There is always one question per line, and a question cannot go over to multiple lines. All questions look like one of the two following:
# This is a comment! For now, they are just full-line comments, but soon there'll be ones at the end of lines!
# ^ Look! An empty space! Those are allowed!
This is a question, [this is an answer!]. An answer can look like [this first one | this second one!]!
# │ │ │ │
# │ │ │ │
# This is a one-off answer. If the user If the user inputs either of these
# inputs it fully, they get it right! correctly, they get it right!
# In this kind of question, you can input from a list in any order!
The four seasons are: {1}, {1}, {1}, {1}. The best kind of ice cream is either {2} or {2}; spring, summer, fall, winter; vanilla, lavender, peanut butter
# │ │ │ │ │ │
# │ │ ┌───────────────────────────────┘ │ │ │
# │ │ │ ┌────────┘ │ │
# │ │ Not all options have to be used. │ │
# │ │ │ │
# │ │ This separates the regular question from the
# │ │ start of the answers and each answer from the
# The user can input four items from the first list (spring, next. However, you can't go back to questions
# summer, fall, winter) in any order here. No repeats, though! after putting this in!
Quickstudy can also search from as many files as you want to use, so you can just put them all in the command to call it!