From 875014ebcb8898e6161e7e2d09b127fc4fa595a2 Mon Sep 17 00:00:00 2001 From: Andreea Radoescu Date: Sun, 20 Oct 2024 15:56:56 +0200 Subject: added README --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1404c25 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +## Overview + +Repository containing implementation for flashcard-based applications. + +### Set up + +- Need to have `python3.12` preinstalled +- Run `./bootstrap-venv.sh` to create the environment and install the packages +- Need to have flashcard files (can clone the schwiizertuutsch repo for this): `git clone git.0xf7.com:schwiizertuutsch` + +### Run applications + +#### Running cli-based flashcards + +Call `./venv/bin/python cli-project/flashcard_cli.py practice ` to start practicing + +> STATE_FILE - is a txt file where the progression state is kept - for a more efficient learning with the flashcards, based on how often you got them right or wrong + +> PATH_TO_FLASHCARDS - paths to the `.fcard` files containing the flashcards contents + + +#### Running GUI application + +To run the GUI application, you need to update paths in `gui-project/main_ui.py`: + - `FLASHCARDS_ROOT` = path to folder containing `.fcard` files + - `STATE_FILE` = path to file for storing and using the state + + Then run: + `./venv/bin/python gui-project/main.py` -- cgit v1.2.3