📚📦 StudyBox (SBX) - Terminal Flashcards

---

• 👉👉 Guide & Library Documentation
• 👉👉 Tutorial - Flashcard study session without leaving your terminal

---

Credits 🙇‍♂️

• Sm2 - Algorithm by Super Memo
• prompt-toolkit - TUI library. 😎

Why ? 🤔

• Wanted a flashcard solution that uses markdown.
• I wanted to memorise useful information.
• GitHub/Gitlab/etc,.. readable flashcards.

Installation (Unix, Windows)

Install from PyPI (pipx)

pipx install sbx

• Alternatively you can install it using pip3 install sbx (On some OSes this is pip install sbx)

Install latest with pipx

git clone git@github.com:JaDogg/sbx.git
cd sbx
pipx install .

Install latest with setup.py

git clone git@github.com:JaDogg/sbx.git
cd sbx
python setup.py install

Features

• It's markdown. (You can use your own editor, as long as you maintain comments in it)
• Syntax highlighting.
• List files. (leech, last one marked with lowest score, include all, etc.)
• Use your own folder structure. (Study at any level in your structure, recursive or not is up to you)
• Built in editor which shows front and back of the flashcards.
• Push your files to github and you can read them.

Copyright

This software is Copyright (c) 2020 - 2022 Bhathiya Perera.

See the LICENSE file for more information.