readme+makefile+staticexeHEADmoon

1 files changed, 16 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d3117f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# stopwatch
+simple, fast, non-cpu-intensive high-accuracy stopwatch for the terminal.
+
+this program is designed for machines running a unix system interface via terminal/tty. i have done mostly all i could think of to reduce its program size, speed and accuracy, whilst making sure it sleeps for 999us inbetween iterations as to not pressure the cpu core that it runs on.
+
+a static build of the executable is provided alongside the code.
+
+# instructions
+instructions are included in the code.
+
+```
+space => start / pause / resume
+ctrl+c / ctrl+d / eof => exit
+```
+
+this only works on unix.