Skip to content

Commit 3a4367c

Browse files
doc: Add install instructions to README.md
1 parent 07bb9c2 commit 3a4367c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,13 @@ Client library for ActivityWatch in Python.
99

1010
Please see the documentation for usage and examples.
1111

12+
## How to install
13+
14+
To install the latest git version directly from github without cloning, run
15+
`pip install git+https://github.com/ActivityWatch/aw-client.git`
16+
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)