Skip to content

Commit c06bcab

Browse files
doc: Update install instructions in README.md
1 parent e8bae0b commit c06bcab

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
1-
afkwatcher
1+
aw-watcher-afk
22
==========
33

44
[![Build Status](https://travis-ci.org/ActivityWatch/aw-watcher-afk.svg?branch=master)](https://travis-ci.org/ActivityWatch/aw-watcher-afk)
55

6-
Watches your keyboard and mouse activity to determine if you are AFK or not
6+
Watches your keyboard and mouse activity to determine if you are AFK or not
77

8+
## How to install
89

9-
## Install
10+
To install the pre-built application, go to https://activitywatch.net/downloads/
1011

11-
<!-- TODO: Since the installation process is the same for all watchers, it would be nice to keep the information in one place: the docs -->
12+
To build your own packaged application, run `make package`
1213

13-
Normal install:
14+
To install the latest git version directly from github without cloning, run
15+
`pip install git+https://github.com/ActivityWatch/aw-watcher-afk.git`
1416

15-
```sh
16-
make build
17-
```
18-
19-
Developer install (requires `poetry`):
20-
21-
```sh
22-
make build DEV="true"
23-
```
17+
To install from a cloned version, cd into the directory and run
18+
`poetry install` to install inside an virtualenv. If you want to install it
19+
system-wide it can be installed with `pip install .`, but that has the issue
20+
that it might not get the exact version of the dependencies due to not reading
21+
the poetry.lock file.

0 commit comments

Comments
 (0)