docs: add project description and setup instructions to readme

This commit is contained in:
2024-12-15 15:06:29 +00:00
parent f5f0bc06df
commit 592c22ad88
+6
View File
@@ -18,6 +18,12 @@ sudo ./tikker
``` ```
It can be annoying to have the terminal open the whole day. I advise to use tmux or install it as systemd service. If you install it as systemd service, you're sure you'll never miss a key press! Make sure that you define the work directory where the database should be stored in systemd service. It can be annoying to have the terminal open the whole day. I advise to use tmux or install it as systemd service. If you install it as systemd service, you're sure you'll never miss a key press! Make sure that you define the work directory where the database should be stored in systemd service.
## Statistics
For displaying graphs with stats execute:
```
make plot
```
## Compilation ## Compilation
Compilation requires sqlite3 development header files. Compilation requires sqlite3 development header files.
``` ```