You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-8Lines changed: 37 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,48 @@
1
1
# Todolator
2
2
3
+
Todolator is a simple desktop task reminder designed to ensure it is hard to ignore the reminder (unlike other apps using push or in-brwoser notifications).
4
+
5
+
## Why
6
+
7
+
I created Todolator because usual push notifications or in-browser notifications from apps like Google Calendar are not enough to grab my attention and not forget the task at hand. I also had experience with desktop apps like [Kana](https://kanasolution.com/products/kana-reminder/) and [Desktop Reminder](https://www.desktop-reminder.com/en/index.html), however these are now quite outdated and/or not completely free.
8
+
9
+
I also wanted to create a desktop app, learn the basics of Rust and use Tauri - so I can combined all of these in this project.
10
+
11
+
## Use Cases
12
+
13
+
- Reminding of important, one-time tasks
14
+
- E.g. an important meeting
15
+
- Reminding of recurring tasks
16
+
- E.g. paying your bills
17
+
- Combination of the 2 UCs above
18
+
19
+
## Privacy
20
+
21
+
Your data stays on your computer, you decide what to do with it. Todolator uses no telemetry, stores no data about you and does not require internet connection.
22
+
3
23
## Configuration
4
24
5
-
Your tasks and settings' location will depend on your OS:
25
+
### App Data Directory
26
+
27
+
The app data directory location depends on the OS used:
In the location, you can find `tasks.json` holding your tasks, `settings.json` containing app settings and `resources/alarm.mp3` containing the alarm notification sound.
14
42
15
-
**MacOS**
43
+
### Changing the notification sound
16
44
17
-
- ``
45
+
Simply replace the default `alarm.mp3` file in the `resources` directory located inside of the app data directory (see above).
18
46
19
47
## Run Locally
20
48
@@ -33,6 +61,7 @@ The built binary & installers will be created in `src-tauri/target/release`.
33
61
34
62
## TODO
35
63
64
+
- LICENCE
36
65
- Try building for MacOS via GHA pipeline provided by tauri
37
66
- Mention in readme the location of `tasks.json`, `settings.json` and `alarm.mp3`
38
67
- Calendar units for recurrence
@@ -42,7 +71,7 @@ The built binary & installers will be created in `src-tauri/target/release`.
42
71
43
72
- MacOS release
44
73
- Fix title bar (<https://v2.tauri.app/learn/window-customization/#creating-a-custom-titlebar>)
45
-
- Clean up the app data folder when uninstalling (maybe make it optional with a checkbox?)
74
+
- Clean up the app data directory when uninstalling (maybe make it optional with a checkbox?)
0 commit comments