Skip to content

Commit e7e1b5b

Browse files
doc: Add install instructions to README.md
1 parent b2d9179 commit e7e1b5b

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
11
aw-core
22
=======
33

4-
[![Build Status Travis](https://travis-ci.org/ActivityWatch/aw-core.svg?branch=master)](https://travis-ci.org/ActivityWatch/aw-core)
4+
[![Build Status Travis](https://travis-ci.org/ActivityWatch/aw-core.svg?branch=master)](https://travis-ci.org/ActivityWatch/aw-core)
55
[![Build Status Appveyor](https://ci.appveyor.com/api/projects/status/h5cvxoghh1wr4ycr/branch/master?svg=true)](https://ci.appveyor.com/project/ErikBjare/aw-core/branch/master)
66
[![codecov](https://codecov.io/gh/ActivityWatch/aw-core/branch/master/graph/badge.svg)](https://codecov.io/gh/ActivityWatch/aw-core)
77

88

99
Core library for ActivityWatch.
1010

1111

12-
Contents
13-
========
12+
## Contents
1413

1514
- Models
1615
- Schemas
1716
- Filtering algorithms for sensitive data
1817

18+
19+
## How to install
20+
21+
To install the latest git version directly from github without cloning, run
22+
`pip install git+https://github.com/ActivityWatch/aw-core.git`
23+
24+
To install from a cloned version, cd into the directory and run
25+
`poetry install` to install inside an virtualenv. If you want to install it
26+
system-wide it can be installed with `pip install .`, but that has the issue
27+
that it might not get the exact version of the dependencies due to not reading
28+
the poetry.lock file.
29+

0 commit comments

Comments
 (0)