retoor 2ddfa951fa docs: add project description, usage instructions, and compilation guide to README.md
The README is expanded from a single-line description to include a full project overview explaining the application's purpose (monitoring key presses), database storage details (tikker.db in current directory), usage instructions with root execution requirement and tmux/systemd recommendations, and compilation prerequisites (sqlite3-dev) with build commands via Makefile.
2024-12-08 15:30:12 +00:00

Tikker

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
S
Description
Application to monitor your key presses
Readme
3.1 MiB
Languages
C 61.9%
Python 36.7%
Makefile 0.9%
Shell 0.5%