diff --git a/README.md b/README.md index 3554cdc..67ee7d6 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# QtZeiterfassung \ No newline at end of file +# Zeiterfassung +This tool helps me assigning my working hours to various accounts at work. + +## Building from source +``` +git clone https://github.com/0xFEEDC0DE64/QtZeiterfassung.git +mkdir build_QtZeiterfassung +cd build_QtZeiterfassung +qmake ../QtZeiterfassung +make +``` + +## Launching +``` +./zeiterfassung +``` + +This tool saves its configuration using [QSettings](https://doc.qt.io/qt-5/qsettings.html). On linux, the configuration files are placed in `~/.config/db-software/zeiterfassung.conf`. **Be careful!** This config file contains your password in plain text (if you log in correctly). You can alter the code in main.cpp to change the behaviour of QSettings (for example: saving into an ini file at working directory).