Show event-less calendar

1 files changed, 52 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c27e3f7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Getting started
+
+```bash
+nix develop --command cargo run
+```
+
+# TODO
+
+## Show events at specific days
+
+1. Modelize an event as Day + Option<Time>.
+2. Define a simple test list of events.
+3. Show it on the calendar (Order events by time).
+4. Add ellipsis in case an event description is too long, and show the complete
+   message when hovering the mouse.
+5. Allow to scroll vertically through events if there are a lot of events one day.
+
+## CRUD
+
+1. Show a form popup when double clicking on a day.
+2. Save to DB and update the calendar on validating.
+3. Read events from DB on startup.
+4. Modify an event when double clicking.
+5. Delete an event (Right click > Delete).
+
+## Complex event
+
+Be able to specify repetition.
+
+1. Modelize an event.
+2. Update the form.
+3. Update the view.
+4. Update a repetition event.
+
+## API
+
+1. Get list of events today.
+
+## Calendar focus
+
+1. Select previous week (up arrow, scrolling).
+2. Select Next week (down arrow, scrolling).
+3. Select the default focus.
+
+## Type
+
+1. CRUD for list of types (name + color).
+2. Show / hide depending on the type.
+
+## Nice to have
+
+1. Drag & drop events.