From 5693b46cdb51c909dd063f0d49d17e3b1c72f216 Mon Sep 17 00:00:00 2001 From: ache Date: Fri, 20 Mar 2026 07:28:44 +0100 Subject: feat: Add a readme --- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--- demo/demo.avif | Bin 0 -> 12113 bytes 2 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 demo/demo.avif diff --git a/README.md b/README.md index 1f12e1b..af9503d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,63 @@ -Deps -==== +# **deps** – Interactive Quiz to Learn French Geo-Subdivisions (Départements) +A fun and interactive way to learn the **101 French *départements*** (including overseas territories) through quizzes, maps, and challenges. -TODO: Write a README +**📍 [Play now](https://deps.ache.one)** +## 📸 Demo +![deps Quiz Demo](demo/demo.avif) +*Interactive quiz interface showing a department selection challenge.* + +--- + +## **🎯 Features** + + - ✅ **Interactive Quiz Mode** – Test your knowledge with random questions. + - ✅ **Map-Based Learning** – Visualize departments on an interactive map. + - ✅ **No Ads, No Tracking** – Privacy-first, open-source experience. That should be a feature. + - ✅ **Responsive Design** – Works on mobile, tablet, and desktop. + +--- + +## **🛠️ Tech Stack** + +Who care about the stack ? + + - **Frontend:** Svelte, without kit + - **Hosting:** Static site + +--- + +## **🚀 Future Improvements (TODO)** + - **Régions (French administrative regions)** – Expand to 18 regions. + - **Other Countries** – Add support for Spain (*provincias*), Germany (*Bundesländer*), ... No Italy plained ! + - **Offline Mode** – Downloadable quiz for learning without internet. + - **More Languages** – Translate quiz questions for non-French speakers. + +--- + +## **📜 License** +This project is **unlicensed** (public domain). + +You are free to: + - ✔ **Use** it for personal or commercial projects. + - ✔ **Modify** and redistribute it. + - ✔ **Fork** and improve it. + +*(No restrictions, but attribution is appreciated!)* + +--- + +## **💡 How to Contribute** +Want to help improve **deps**? +Just send me the commit over email, git works that way. + +--- + +## **📧 Contact** + +- **Website:** [https://deps.ache.one](https://deps.ache.one) +- **Issues & Feedback:** via email +- **Questions?** Reach out via email. + +Email: ache diff --git a/demo/demo.avif b/demo/demo.avif new file mode 100644 index 0000000..768b6d7 Binary files /dev/null and b/demo/demo.avif differ -- cgit v1.3-2-g11bf