Update readme.

Browse Source
This commit is contained in:
retoor 2024-12-08 16:30:12 +01:00
parent 0dd35f4b86
commit 13275a969b
1 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,3 +1,28 @@
# tikker
# Tikker
Application to monitor your key presses
Tikker is Dutch for typer.
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.
## Usage
Execute as root is important!
```
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.
## Compilation
Compilation requires sqlite3 development header files.
```
sudo apt install libsqlite3-dev
```
Building:
```
make build
```
Building and running:
```
make
```