memorize

README

Memorization app built using Go and Bubble Tea

About

Memorize (better name pending) is a simple app that helps you memorize texts by obscuring part or all of a word, letting you fill in the rest.

How to Use

Set up source texts

For now, source texts are stored in a file called memorize-texts.json that must be in the same directory as the executable. The file contains an array of objects with the required keys "title" and "text." For example:

[
  {
    "title": "Hitchhiker's Guide Cover Text",
    "text": "Don't panic."
  },
  {
    "title": "Bill & Ted's Philosophy",
    "text": "Be excellent to each other."
  }
]

To start, you can use the memorize-texts.json file in the root of the repo.

Text Selection Screen

• Type in the number of a text, followed by enter, to start playing with that text
• Press d to navigate to the difficulty selection screen
• Press ESC to exit

Difficulty selection screen

Select a difficulty by typing a number and pressing enter. The available difficulties are:

1. Learning - Remaining words in a text are completely visible
2. Easy - Words are partially obscured - the second half of characters in a word (rounded down) are obscured
3. Medium - Words are mostly obscured - the first letter of a word is visible, but the rest is obscured
4. Hard - Words are completely obscured, leaving only empty spaces to indicate how many characters are in the word

Game Screen

Play the game by typing words in a text until it has been filled in, pressing space after each typed word.

Title

The title of the selected text is displayed at the top of the screen.

Memorization Text

Spaces are shown indicating the number of words and the number of characters in each word. Depending on the selected difficulty, some of the letters will already be filled in.

Progress

A progress bar displaying how far you are through the current text. Also, a count of current words and total words

Typed word indicator

Your most recently submitted word will be displayed here, along with a symbol indicating whether it was correct.

Text input

Type a word and press space to submit. For convenience, punctuation is ignored.

Documentation

Overview

Copyright © 2021 Samuel Otterman <sjotterman@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.