aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md31
1 files changed, 23 insertions, 8 deletions
diff --git a/README.md b/README.md
index 22873bd..2fada1c 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-# Getting started
+# Features
-```bash
-nix develop --command cargo run
-```
+- Manage events and repeated events.
+- Store events in a single SQLite file.
+- List today’s events with CLI option `--list-today`.
# Screenshot
@@ -14,15 +14,29 @@ nix develop --command cargo run
- gtk4-rs documentation: https://gtk-rs.org/gtk4-rs/stable/latest/docs/gtk4/
- Event-Driven GTK by Example — 2021 Edition: https://mmstick.github.io/gtkrs-tutorials/
-# Tests
+# Getting started
+
+Bootstrap a shell with all the required dependencies with `nix develop` (requires nix).
+
+Start the application with:
+
+```bash
+cargo run
+```
+
+Run tests with:
+```bash
cargo test
+```
-# TODO
+Get today’s events with:
-## Description
+```bash
+cargo run -- --list-today
+```
-- Add description textarea field.
+# TODO
## Optimizations
@@ -45,3 +59,4 @@ cargo test
- Print errors on forms when validating.
- Validate the form when pressing enter on any field.
- Select the default focus with a button or a shortcut.
+- Add description textarea field ?