Commit 6abada8e authored by Daniel Steuer's avatar Daniel Steuer
Browse files

readme: extend and respect 80 char line limit

parent a7a61a4e
......@@ -3,7 +3,10 @@
simple flex time tracker
## Usage
Wenn started the programm will automatically assume the User has arrived at work. By clicking the tray icon the user can switch between work and break time. The current state and accumulated time can be observed via the tooltip and tray icon.
When started the programm will automatically assume the user has arrived at
work. By clicking the tray icon the user can switch between work and break
time. The current state and accumulated time can be observed via the tooltip
of the tray icon or in the timesheet overview.
It is reccommended to launch outatime at windows startup.
## Features
......@@ -22,7 +25,8 @@ To install dependencies you can use the requirements file
pip install -r requirements.txt
```
Alternatively you can install dependencies manually but keep in mind that some libraries are version dependant
Alternatively you can install dependencies manually. Keep in mind that some
libraries are version dependant
```
pip install pystray==0.19.1
pip install pyinstaller
......@@ -30,17 +34,17 @@ pip install PySimpleGUI
pip install toml
```
## Install
To compile into an single exe file use
## Delivery Creation
To compile into an single executable file ready for distribution run the delivery script.
```
pyinstaller.exe --clean --distpath ./dist/outatime --specpath ./build --noconsole --onefile --hidden-import pystray._win32 --name outatime main.py
python make-delivery.py
```
Create the following file structure
## Troubleshooting and Reporting
In case you encounter a bug and know a way to reproduce it, please consider
running the application with the parameter --debug. This will enable extensive
logoutput to the console.
```
/config.toml
/outatime.exe
/gfx/
/gfx/trayIcon_onBreak.png
/gfx/trayIcon_working.png
/gfx/trayIcon_default.png
outatime.exe --debug
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment