README update.

Browse Source
This commit is contained in:
retoor 2024-12-08 20:38:17 +01:00
parent be6acf3e0e
commit f4276ec503
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -6,6 +6,11 @@ This is an application for monitoring your key presses.
It will store all your keypresses in a database called 'tikker.db' in current work directory. It will store all your keypresses in a database called 'tikker.db' in current work directory.
Pre-build binaries:
- Download using `curl -OJ https://retoor.molodetz.nl/api/packages/retoor/generic/tikker/1.0.0/tikker`
.
- Or download using `wget https://retoor.molodetz.nl/api/packages/retoor/generic/tikker/1.0.0/tikker`.
## Usage ## Usage
Execute as root is important! Execute as root is important!
``` ```
@ -13,12 +18,6 @@ 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.
Pre-build binaries:
- Download using `curl -OJ https://retoor.molodetz.nl/api/packages/retoor/generic/tikker/1.0.0/tikker`
.
- Or download using `wget https://retoor.molodetz.nl/api/packages/retoor/generic/tikker/1.0.0/tikker`.
## Compilation ## Compilation
Compilation requires sqlite3 development header files. Compilation requires sqlite3 development header files.
``` ```