Initial commit

.gitignore

@@ -0,0 +1,583 @@
+# Created by https://www.toptal.com/developers/gitignore/api/csharp,visualstudio
+# Edit at https://www.toptal.com/developers/gitignore?templates=csharp,visualstudio
+
+### Csharp ###
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.tlog
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+*.vbp
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+*.dsw
+*.dsp
+
+# Visual Studio 6 technical files
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# Visual Studio History (VSHistory) files
+.vshistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Windows Installer files from build outputs
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# JetBrains Rider
+*.sln.iml
+
+### VisualStudio ###
+
+# User-specific files
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+
+# Mono auto generated files
+
+# Build results
+
+# Visual Studio 2015/2017 cache/options directory
+# Uncomment if you have tasks that create the project's static files in wwwroot
+
+# Visual Studio 2017 auto generated files
+
+# MSTest test Results
+
+# NUnit
+
+# Build Results of an ATL Project
+
+# Benchmark Results
+
+# .NET Core
+
+# ASP.NET Scaffolding
+
+# StyleCop
+
+# Files built by Visual Studio
+
+# Chutzpah Test files
+
+# Visual C++ cache files
+
+# Visual Studio profiler
+
+# Visual Studio Trace Files
+
+# TFS 2012 Local Workspace
+
+# Guidance Automation Toolkit
+
+# ReSharper is a .NET coding add-in
+
+# TeamCity is a build add-in
+
+# DotCover is a Code Coverage Tool
+
+# AxoCover is a Code Coverage Tool
+
+# Coverlet is a free, cross platform Code Coverage Tool
+
+# Visual Studio code coverage results
+
+# NCrunch
+
+# MightyMoose
+
+# Web workbench (sass)
+
+# Installshield output folder
+
+# DocProject is a documentation generator add-in
+
+# Click-Once directory
+
+# Publish Web Output
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+
+# NuGet Packages
+# NuGet Symbol Packages
+# The packages folder can be ignored because of Package Restore
+# except build/, which is used as an MSBuild target.
+# Uncomment if necessary however generally it will be regenerated when needed
+# NuGet v3's project.json files produces more ignorable files
+
+# Microsoft Azure Build Output
+
+# Microsoft Azure Emulator
+
+# Windows Store app package directories and files
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+# but keep track of directories ending in .cache
+
+# Others
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+
+# RIA/Silverlight projects
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+
+# SQL Server files
+
+# Business Intelligence projects
+
+# Microsoft Fakes
+
+# GhostDoc plugin setting file
+
+# Node.js Tools for Visual Studio
+
+# Visual Studio 6 build log
+
+# Visual Studio 6 workspace options file
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+
+# Visual Studio 6 technical files
+
+# Visual Studio LightSwitch build output
+
+# Paket dependency manager
+
+# FAKE - F# Make
+
+# CodeRush personal settings
+
+# Python Tools for Visual Studio (PTVS)
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+
+# Telerik's JustMock configuration file
+
+# BizTalk build output
+
+# OpenCover UI analysis results
+
+# Azure Stream Analytics local run output
+
+# MSBuild Binary and Structured Log
+
+# NVidia Nsight GPU debugger configuration file
+
+# MFractors (Xamarin productivity tool) working folder
+
+# Local History for Visual Studio
+
+# Visual Studio History (VSHistory) files
+
+# BeatPulse healthcheck temp database
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+
+# Ionide (cross platform F# VS Code tools) working folder
+
+# Fody - auto-generated XML schema
+
+# VS Code files for those working on multiple tools
+
+# Local History for Visual Studio Code
+
+# Windows Installer files from build outputs
+
+# JetBrains Rider
+
+### VisualStudio Patch ###
+# Additional files built by Visual Studio
+
+# End of https://www.toptal.com/developers/gitignore/api/csharp,visualstudio

CleanSolutionDir.ps1

@@ -0,0 +1,3 @@
+Get-ChildItem -Path $PSScriptroot -Recurse -Force  -Include '.vs', '.git', 'bin', 'obj', '.idea', '*.Dotsettings', '*.Dotsettings.user' | ForEach-Object {
+    Remove-Item -Recurse -Force -LiteralPath $_.FullName >$null
+}

VocabularyTrainer.sln

@@ -0,0 +1,28 @@
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.32126.317
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "VocabularyTrainer", "VocabularyTrainer\VocabularyTrainer.csproj", "{F687519F-3209-44B6-81BF-DDD2466FEEF2}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C0CE7914-5D5B-4C90-A993-A8F8CC7002E8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C0CE7914-5D5B-4C90-A993-A8F8CC7002E8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C0CE7914-5D5B-4C90-A993-A8F8CC7002E8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C0CE7914-5D5B-4C90-A993-A8F8CC7002E8}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {B7BD828E-2CBE-4D53-BA50-CC9536773BE0}
+	EndGlobalSection
+EndGlobal

VocabularyTrainer/Data/translations.csv

@@ -0,0 +1,9 @@
+English;German
+cat;Katze
+dog;Hund
+bicycle;Fahrrad
+car;Auto
+airplane;Flugzeug
+tree;Baum
+cloud;Wolke
+horse;Pferd

VocabularyTrainer/Program.cs

@@ -0,0 +1,85 @@
+using Figgle;
+using System.Text;
+using VocabularyTrainer;
+
+Console.OutputEncoding = Encoding.UTF8;
+
+Console.WriteLine($"*** Vocabulary Trainer ***{Environment.NewLine}");
+
+var trainer = new Trainer(ReadTranslationsFromFile());
+var option = 1;
+do
+{
+    switch (option)
+    {
+        case 1:
+        {
+            trainer.PerformTrainingCycle(); 
+            break;
+        }
+        case 2:
+        {
+            trainer.PrintStatistics(); 
+            break;
+        }
+        // why don't we have to check for case 3 here?
+        default:
+        {
+            Console.WriteLine("Invalid option"); 
+            break;
+        }
+    }
+    option = ReadOption();
+} while (option != 3);
+
+PrintGoodbye();
+
+return;
+
+static int ReadOption()
+{
+    Console.ForegroundColor = ConsoleColor.DarkCyan;
+    Console.WriteLine("(1) Another try?");
+    Console.WriteLine("(2) Print Statistics");
+    Console.WriteLine("(3) Quit");
+    Console.Write("Please select an option: ");
+    Console.ResetColor();
+
+    int option;
+    string? input;
+    do
+    {
+        input = Console.ReadLine();
+        if (string.IsNullOrWhiteSpace(input))
+        {
+            Console.WriteLine("Invalid input, try again");
+        }
+    } while (!int.TryParse(input, out option) || option is < 1 or > 3);
+    return option;
+}
+
+static void PrintGoodbye()
+{
+    Console.Clear();
+    Console.ForegroundColor = ConsoleColor.DarkCyan;
+    Console.WriteLine(
+        FiggleFonts.Standard.Render("Bye!"));
+    Console.Write("Press any key to finish ... ");
+    Console.ResetColor();
+    Console.ReadKey();
+}
+
+static string[][] ReadTranslationsFromFile()
+{
+    // we assume the file exists and is valid - this time
+    string[] lines = File.ReadAllLines("Data/translations.csv");
+    var words = new string[lines.Length - 1][];
+    for (var i = 0; i < words.Length; i++)
+    {
+        string line = lines[i + 1];
+        string[] parts = line.Split(';');
+        words[i] = parts;
+    }
+
+    return words;
+}

VocabularyTrainer/RandomProvider.cs

@@ -0,0 +1,6 @@
+namespace VocabularyTrainer;
+
+public static class RandomProvider
+{
+    public static Random Random { get; } = Random.Shared;
+}

VocabularyTrainer/Trainer.cs

@@ -0,0 +1,94 @@
+using Figgle;
+
+namespace VocabularyTrainer;
+
+/// <summary>
+///     Vocabulary trainer.
+///     Based on a supplied vocabulary training cycles are performed.
+/// </summary>
+public sealed class Trainer
+{
+    private const int WordIdx = 0;
+    private const int TranslationIdx = 1;
+    private const int CycleCount = 3;
+    private readonly VocabularyItem[] _vocabularyItems;
+
+    /// <summary>
+    ///     Constructs a new <see cref="Trainer"/> instance based on the given vocabulary.
+    /// </summary>
+    /// <param name="wordsAndTranslations">Raw vocabulary read from a file</param>
+    public Trainer(string[][] wordsAndTranslations)
+    {
+        _vocabularyItems = CreateVocabularyItems(wordsAndTranslations);
+    }
+
+    /// <summary>
+    ///     Performs a training cycle for <see cref="CycleCount"/> words.
+    /// </summary>
+    public void PerformTrainingCycle()
+    {
+        Console.Clear();
+        Console.ForegroundColor = ConsoleColor.DarkCyan;
+        Console.WriteLine(FiggleFonts.Standard.Render("Vocabulary Trainer"));
+        Console.WriteLine($"Starting a new training cycle with {CycleCount} tries ...");
+        var alreadyAsked = new bool[_vocabularyItems.Length];
+        for (var i = 0; i < CycleCount; i++)
+        {
+            // TODO
+            Console.ResetColor();
+        }
+        Console.WriteLine();
+    }
+
+    /// <summary>
+    ///     Prints training statistics to the terminal.
+    /// </summary>
+    public void PrintStatistics()
+    {
+        Sort();
+
+        Console.Clear();
+        Console.ForegroundColor = ConsoleColor.DarkCyan;
+        Console.WriteLine(FiggleFonts.Standard.Render("Training Statistics"));
+        Console.WriteLine($"{"English",-10} {"German",-10} {"Asked",-5} {"Correct",-7}");
+        Console.WriteLine(new string('-', 35));
+        Console.ForegroundColor = ConsoleColor.DarkYellow;
+        foreach (var vocabularyItem in _vocabularyItems)
+        {
+            Console.WriteLine(vocabularyItem);
+        }
+        Console.WriteLine();
+        Console.ResetColor();
+    }
+
+    /// <summary>
+    ///     Picks the next word by random.
+    ///     If all words have already been used any one is chosen.
+    /// </summary>
+    /// <param name="alreadyAsked">An array of flags indicating which words have already been used</param>
+    /// <returns>Index of next word to use</returns>
+    private int PickNextWord(bool[] alreadyAsked)
+    {
+        // TODO
+        return -1;
+    }
+
+    /// <summary>
+    ///     Sorts the vocabulary items using the CompareTo method of the <see cref="VocabularyItem"/> class.
+    /// </summary>
+    private void Sort()
+    {
+        // TODO
+    }
+
+    /// <summary>
+    ///     Creates a <see cref="VocabularyItem"/> array from the raw words.
+    /// </summary>
+    /// <param name="wordsAndTranslations">Raw vocabulary read from a file</param>
+    /// <returns>A <see cref="VocabularyItem"/> for each (valid) word</returns>
+    private static VocabularyItem[] CreateVocabularyItems(string[][] wordsAndTranslations)
+    {
+        // TODO
+        return [];
+    }
+}

VocabularyTrainer/VocabularyItem.cs

@@ -0,0 +1,9 @@
+namespace VocabularyTrainer;
+
+/// <summary>
+///     Represents one word in the vocabulary
+/// </summary>
+public sealed class VocabularyItem
+{
+    // TODO
+}

VocabularyTrainer/VocabularyTrainer.csproj

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<OutputType>Exe</OutputType>
+		<TargetFramework>net8.0</TargetFramework>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<Nullable>enable</Nullable>
+		<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+	</PropertyGroup>
+
+	<ItemGroup>
+	  <PackageReference Include="Figgle" Version="0.5.1" />
+	</ItemGroup>
+
+	<ItemGroup>
+		<None Update="Data\*.csv">
+			<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+		</None>
+	</ItemGroup>
+
+</Project>

readme.adoc

@@ -0,0 +1,149 @@
+:sectnums:
+:nofooter:
+:toc: left
+:icons: font
+:data-uri:
+:source-highlighter: highlightjs
+
+= OOB.03 -- Vocabulary Trainer
+
+This time you are going to implement a vocabulary trainer.
+It will only be terminal based, but we'll use some fancy colors and headings at least.
+
+[plantuml]
+----
+@startuml
+
+class Trainer {
+    -int WORD_IDX [const]
+    -int TRANSLATION_IDX [const]
+    -int CYCLE_COUNT [const]
+    -VocabularyItem[] _vocabularyItems [readonly]
+
+    +Trainer(string[][])
+    +void PerformTrainingCycle()
+    +void PrintStatistics()
+    -int PickNextWord(bool[])
+    -void Sort()
+    {static} -VocabularyItem[] CreateVocabularyItems(string[][])
+}
+
+class VocabularyItem {
+    -int _countCorrect
+    -int _countAsked
+    +string NativeWord [readonly]
+    +string Translation [readonly]
+
+    +VocabularyItem(string, string)
+    +bool TestTranslation(string)
+    +int CompareTo(VocabularyItem)
+    +string ToString() [override]
+    {static} -int CompareStrings(string, string)
+}
+
+Trainer "1" -r- "n" VocabularyItem: has
+
+@enduml
+----
+
+Some parts of the application have already been provided to you, especially the `Program.cs` file.
+
+CAUTION: You might need to comment some code to allow the program to compile initially
+
+== `VocabularyItem` class
+
+This class is meant to hold one 'word':
+
+. The 'native' word
+. The translation
+
+For example: 'horse' & 'Pferd'.
+
+It also holds information about the 'translation success' of the user who is currently training:
+
+* How often was user 'asked' to translate this specific word
+* How often did the user get it right (correct translation)
+
+The following operations are supported:
+
+* Test a user provided translation
+** Returns `true` or `false` accordingly
+** Updates the internal statistics
+* Compare to another instance of `VocabularyItem`
+** Used for sorting before displaying the statistics
+** First we compare the number of correct answers. +
+If those are equal we then compare the native words lexically.
+* Create a `string` representation of the `VocabularyItem` instance
+** This method requires the `override` keyword, we'll talk about that later.
+For now just put it there and be happy that everything works.
+* Compare two strings lexically while ignoring case
+** This is an internal helper method
+** Look up https://learn.microsoft.com/en-us/dotnet/api/system.string.compare?view=net-6.0[`string.Compare`] & `StringComparison.OrdinalIgnoreCase` in the documentation for the implementation of this method
+
+.Cheating: Look at the XMLDoc of the methods if you have a hard time understanding what each is supposed to do
+[%collapsible]
+====
+[source,csharp]
+----
+/// <summary>
+///     A translation attempt is checked for correctness.
+/// </summary>
+/// <param name="translationAttempt">The user provided translation</param>
+/// <returns>True if the translation was correct; false otherwise</returns>
+
+/// <summary>
+///     The vocabulary item is compared to another. First the number of correct answers is compared.
+///     If it is equal the native words are compared ordinal.
+/// </summary>
+/// <param name="other">The <see cref="VocabularyItem"/> to compare with</param>
+/// <returns>0 if equal; less than 0 if this item is smaller; greater than 0 otherwise</returns>
+
+/// <summary>
+///     Overrides the default string representation to display the word and translation statistics.
+/// </summary>
+/// <returns>A string containing the word, its translation and the training statistics</returns>
+
+/// <summary>
+///     Compares two strings by ordinal value, ignoring case.
+/// </summary>
+/// <param name="a">First string</param>
+/// <param name="b">Second string</param>
+/// <returns>Less than 0 if a precedes b in the sorting order; greater than 0 if b precedes a; 0 otherwise</returns>
+----
+====
+
+== `Trainer` class
+
+This class contains the vocabulary and is responsible for guiding the user through a training cycle.
+
+NOTE: A considerable part of the 'user interface' is handled by `Program`, be aware which class performs which action(s) based on its purpose
+
+It provides the following operations:
+
+* Turn 'raw' words read from the `vocabulary.csv` file (provided as `string[][]`) into an array of `VocabularyItem` instances
+** Invalid entries (native word, translation or both are `null` _or empty_) are skipped => the final array is trimmed as usual (or rather, a temporary array can be used)
+*** That's easily possible with two loops in total (within this method)
+** Make use of the `WORD_IDX` & `TRANSLATION_IDX` constants
+* Sort the vocabulary
+** The sorting happens in-place
+*** Use any algorithm you want
+** Called before printing the statistics
+** Make use of the `CompareTo` method of the `VocabularyItem` class
+* Randomly pick the next word (from the vocabulary) to show to the user
+** In general, words are picked by random.
+However, a word should not reappear while another hasn't been used yet.
+To implement this logic use the `bool[]` in which you can track which vocabulary items have already been used (via index).
+Draw a new random number until you get an 'unused' word.
+*Once all words have been used at least once any one is chosen.*
+*** Keep in mind: an array parameter is passed by _reference_ => useful here
+** Make sure to use the `RandomProvider` otherwise you'll have a _very hard_ time writing your unit tests
+* Print training statistics
+** Already implemented for you
+* Perform a training cycle
+** _Partially_ implemented already
+** Look at the sample run to learn about the expected interaction and output format
+** Make sure to call the `TestTranslation` method of the _proper_ `VocabularyItem` _instance_ when checking translation input
+
+== Sample Run
+
+video::sample_run.mp4[Sample Run]