From d75d484075cd2166daf726e12b4353fcfd2d80f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lie=20DELHAIE?= Date: Sun, 22 Mar 2026 21:51:03 +0100 Subject: [PATCH] add README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bec74e6 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# ToDo + +Small **C++/Qt** (Widgets) task list application with local **SQLite** persistence. + +## Features + +- Create, rename, and delete lists. +- Create, edit, and delete notes/tasks. +- Mark tasks as completed. +- Automatic local save in a SQLite database. + +## Requirements + +- Qt (`widgets` and `sql` modules) +- `qmake` +- A C++17 compiler + +## Quick Build + +From the project root: + +```bash +qmake ToDo.pro +make +``` + +## Run the Application + +```bash +./ToDo +``` + +## Data + +Data is stored in a `todo.sqlite3` SQLite file, created in the app data directory (`QStandardPaths::AppDataLocation`). + +## Project Structure + +- `src/gui`: user interface (windows, dialogs). +- `src/core`: business services (`ListService`, `NoteService`). +- `src/obj`: domain objects (`List`, `Note`).