Added functionality for initializing the project and for studying, and improved README.

Author: bfeif

README.md

@@ -1,8 +1,25 @@
 # denkmit
 A SRS-flashcard app, specialized for German-language-learning. Uses Django as ORM, Postgres as DB, Poetry for environment management.
 
-## `experiments`
-Jupyter notebooks containing experiments regarding ideas for the project.
 
-## `flashcards`
-The main flashcards app of the project. At present, all flashcard functionality is run through a terminal UI.
+## About
+The best way to learn a language is to have real conversations in your target language as much as possible! Seems easy enough. However, any language learning process is greatly boosted by book-studying, including a little bit of (yes, I know) memorization. In particular, learning the German language requires an unusually high amount of memorization: adjective declensions, preposition declensions, patternless noun genders, and more.
+
+The point of denkmit is to enable you to do this necessary memorization as efficiently as possible, by using the well-researched memorization tool of Spaced Repetition Software (SRS). Denkmit gives you exercises in preposition declension, noun gender-guessing, and standard vocabulary learning. With 5 minutes a day of denkmit, you can permanently know all the preposition declensions in under a month.
+
+
+## Setup
+So, you want to denkmit? At the moment, denkmit only supports a terminal UI for learning German flashcards. Let's get the project set up:
+1. This project uses poetry for environment management, so install that first (instructions [here](https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions)).
+2. Initialize the project by running `./initialize_denkmit.sh`.
+
+Great, the project is set up! Head to the next section to see how to start learning.
+
+
+## How to Learn Today
+So, you've got the project set up, and now you're ready to start learning.
+1. (Optional) Set the exercises that you want to learn for the day in `config/flashcard_config.py`
+1. Get started with your German practice by running `poetry run python flashcards/learn_today_flashcards.py`!
+```
+
+```

config/flashcard_config.py

@@ -0,0 +1,12 @@
+from flashcards.models import PrepositionDeclination_Card, InfinitiveVerbDeEnMeaning_Card, \
+    InfinitiveVerbEnDeMeaning_Card, NounEnDeMeaning_Card, NounDeEnMeaning_Card, PersonalPronoun_Card
+
+
+FLASHCARD_CONFIG = {
+    PrepositionDeclination_Card: True,
+    PersonalPronoun_Card: True,
+    InfinitiveVerbDeEnMeaning_Card: False,
+    InfinitiveVerbEnDeMeaning_Card: False,
+    NounEnDeMeaning_Card: False,
+    NounDeEnMeaning_Card: False,
+}

data/personal_pronoun_table.csv

@@ -2,9 +2,9 @@ word_de,word_en,case,plural_order,person_order,nominativ
 ich,I,Nom,singular,1,ich
 mir,me,Dat,singular,1,ich
 mich,me,Akk,singular,1,ich
-du,you,Nom,singular,2,du
-dir,you,Dat,singular,2,du
-dich,you,Akk,singular,2,du
+du,you (informal),Nom,singular,2,du
+dir,you (informal),Dat,singular,2,du
+dich,you (informal),Akk,singular,2,du
 Sie,you (formal),Nom,formal,2,Sie
 Ihnen,you (formal),Dat,formal,2,Sie
 Sie,you (formal),Akk,formal,2,Sie

flashcards/learn_today_flashcards.py

@@ -0,0 +1,10 @@
+import os
+import django
+os.environ["DJANGO_SETTINGS_MODULE"] = 'denkmit.settings'
+django.setup()
+from config import flashcard_config
+
+
+exercises_for_today = [model for model, to_study in flashcard_config.FLASHCARD_CONFIG.items() if to_study==True]
+for exercise in exercises_for_today:
+    exercise.learn_today_flashcard_deck()

initialize_denkmit.sh

@@ -0,0 +1,10 @@
+poetry run python manage.py migrate --run-syncdb
+poetry run python << END
+import os
+import django
+os.environ["DJANGO_SETTINGS_MODULE"] = 'denkmit.settings'
+django.setup()
+from django.contrib.contenttypes.models import ContentType
+ContentType.objects.all().delete()
+END
+poetry run python data_loaders/load_models_from_data.py