flashMe

README

flashMe

FlashMe is a terminal-based flashcard application written in Go using the Bubble Tea framework. It provides a simple and efficient way to study and review flashcards right from your command line. FlashMe is designed to be easy to use, customizable, and distraction-free.

Features

• flashMe offers a user-friendly interface where users can navigate through flashcards using keyboard commands.
• Each flashcard displays a question, and users can reveal the answer with a single keystroke.

Installation

To get FlashMe, make sure you have Go installed on your system, and start by cloning the repo

go install github.com/burgr033/flashMe/cmd/flashMe@v1.0.0

Usage

After installing FlashMe, start the application by running:

flashMe

flashMe needs a cards.txt in the current directory which has a tab separated list of questions

Das ist eine Testfrage?	Das ist eine Testantwort
What does $O(1)$ mean?	Big-O describes the runtime complexity of an algorithm or program. $O(1)$ means, that the time complexity is constant

Follow the on-screen instructions to navigate through the flashcards and review your study materials.

Contributing

As I am new to Go, contributions to FlashMe are very welcome! If you have any ideas, suggestions, or bug fixes, feel free to open an issue or submit a pull request on GitHub.

Roadmap

• The next thing I will work on, is the ability to put in data after compilation. As of now you can only insert data by

License

FlashMe is licensed under the MIT License.

Acknowledgements

FlashMe is built using Bubble Tea, a terminal UI framework for Go by Charmbracelet. Special thanks to the developers and contributors of Bubble Tea for providing such a powerful and versatile framework for building terminal-based applications.