From 4f302005440f7c7ee31bad99d445f927a4935902 Mon Sep 17 00:00:00 2001 From: Trey t Date: Thu, 9 Apr 2026 21:02:27 -0500 Subject: [PATCH] Add README with project overview and architecture summary Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..597344e --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Conjuga + +A Spanish verb conjugation learning app for iOS. Practice all 20 tenses with spaced repetition, handwriting recognition, and vocabulary courses. + +## Features + +- **Conjugation Practice** — Flashcards, typing, multiple choice, handwriting, sentence building, and full table modes +- **Spaced Repetition** — SM-2 algorithm tracks what you know and surfaces what you don't +- **1,750 Verbs** — From basic to expert, with irregular form highlighting +- **20 Tenses** — Every indicative, subjunctive, conditional, and imperative tense +- **Grammar Guide** — 20 tense guides with conjugation tables + 20 grammar topic notes (Ser vs Estar, Por vs Para, etc.) +- **Vocabulary Courses** — Weekly decks with example sentences +- **Progress Tracking** — Streaks, daily goals, accuracy stats, and achievement badges +- **CloudKit Sync** — Review progress syncs across devices +- **Widgets** — Daily progress, word of the day, and weekly stats +- **Text-to-Speech** — Hear any verb pronounced in Spanish + +## Architecture + +- **SwiftUI** + **SwiftData** with a dual-store configuration: + - **Local store** — Reference data (verbs, forms, guides) seeded from JSON on first launch + - **Cloud store** — User data (review cards, progress, streaks) synced via CloudKit +- **SharedModels** package shared between the app and widget extension + +## Requirements + +- iOS 18+ +- Xcode 16+ + +## Building + +Open `Conjuga/Conjuga.xcodeproj` in Xcode and run on a simulator or device. Data seeds automatically on first launch.