diff --git a/README.md b/README.md new file mode 100644 index 0000000..d43896c --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Timer +A simple timer. + +## Usage +Left click the timer to pause/unpause it. +Right click the timer to reset it. +``` +timer hours minutes seconds +``` + +## Building +To build the project use the following commands +```bash +git clone https://github.com/KalleStruik/Timer +cd Timer +mkdir cmake-build +cd cmake-build +cmake ../ +make +```