Create README.md

hoothin · May 25, 2023 · c42a930 · c42a930
1 parent f401b5b
commit c42a930
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# Rust Clock
+Clock popup every half hour. Build with rust|egui|rodio|tray-icon
+
+![example](pic.png)
+# Config
+Edit the cong.ini with rust_clock.
++ time
+The time when rust clock will popup, set by `hour:minute:second`. Split multi-time by `,`.
+``` ini
+# popup every half hour
+time=:30:
+```
+``` ini
+# popup every half hour and 15:50:00
+time=:30:,15:50:
+```
++ sound
+The sound file you wish to play when clock popup.
+``` ini
+# play sound.ogg when popup
+sound=sound.ogg
+```