aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorache <ache@ache.one>2026-03-20 07:28:44 +0100
committerache <ache@ache.one>2026-03-20 07:30:38 +0100
commit5693b46cdb51c909dd063f0d49d17e3b1c72f216 (patch)
treefa66eac3d6b37ae531e465b6f2fb9f885edac5a2
parentfix: Trier les départements par nom (diff)
feat: Add a readme
-rw-r--r--README.md63
-rw-r--r--demo/demo.avifbin0 -> 12113 bytes
2 files changed, 60 insertions, 3 deletions
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 <ache.deps@ache.one>
diff --git a/demo/demo.avif b/demo/demo.avif
new file mode 100644
index 0000000..768b6d7
--- /dev/null
+++ b/demo/demo.avif
Binary files differ