Browse Source

Add README

rexim 5 years ago
parent
commit
9ab282a1c9
1 changed files with 25 additions and 0 deletions
  1. 25 0
      README.md

+ 25 - 0
README.md

@@ -0,0 +1,25 @@
+# Sowon
+
+## Build
+
+Dependencies: [SDL2](https://www.libsdl.org/download-2.0.php)
+
+```console
+$ make
+```
+
+## Usage
+
+### Modes
+
+- Ascending mode: `./sowon`
+- Descending mode: `./sowon <seconds>`
+
+### Key bindings
+
+| Key | Description |
+| --- | --- |
+| <kbd>SPACE</kbd> | Toggle pause |
+| <kbd>=</kbd> | Zoom in |
+| <kbd>-</kbd> | Zoom out |
+| <kbd>0</kbd> | Zoom 100% |