docs: add project description and setup instructions to README

Browse Source 
The README now includes a brief overview of the project's purpose, prerequisites for running the application, and step-by-step installation commands for new contributors.
This commit is contained in:
retoor 2024-12-08 18:50:42 +00:00
parent ad70f34f3f
commit c52a18ee59
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -13,6 +13,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.
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.
``` ```

BIN
tikker
View File

Binary file not shown.