From bc334385e5d2ecc57ae2864085300e672c3912de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20Bj=C3=A4reholt?= Date: Wed, 22 Apr 2020 08:57:25 +0200 Subject: [PATCH] doc: Add install instructions to README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 94990db..8cfd46d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,22 @@ Cross-platform window-Watcher for Linux (X11), macOS, Windows. [![Build Status](https://travis-ci.org/ActivityWatch/aw-watcher-window.svg?branch=master)](https://travis-ci.org/ActivityWatch/aw-watcher-window) -### Note to macOS users +## How to install + +To install the pre-built application, go to https://activitywatch.net/downloads/ + +To build your own packaged application, run `make package` + +To install the latest git version directly from github without cloning, run +`pip install git+https://github.com/ActivityWatch/aw-watcher-window.git` + +To install from a cloned version, cd into the directory and run +`poetry install` to install inside an virtualenv. If you want to install it +system-wide it can be installed with `pip install .`, but that has the issue +that it might not get the exact version of the dependencies due to not reading +the poetry.lock file. + +## Note to macOS users To log current window title the terminal needs access to macOS accessibility API. This can be enabled in `System Preferences > Security & Privacy > Accessibility`, then add the Terminal to this list. If this is not enabled the watcher can only log current application, and not window title.