Added README.md

Signed-off-by: 0xf8 <0xf8.dev@proton.me>
2023-02-25 12:06:52 -05:00
parent db95c6f0d0
commit d23e410c8f
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+# Tempus - Time
+A nice little clock app.
+
+## Reading the clock
+- Left side of the `|` is the hour
+- Right side of the `|` is the minute
+- The highlighted number is the second
+
+# Dependencies
+- ncurses
+- clang
+- make
+
+# Compiling
+`make`
+
+# Running
+`./tempus`