Skip to content

Commit e745209

Browse files
authored
Merge pull request #109 from dknowles2/dknowles2-patch-1
Add installation instructions
2 parents 1374b4f + da644fb commit e745209

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,39 @@ print(locks[0].name)
2222
lock[0].lock()
2323
```
2424

25+
## Installation
26+
27+
### Pip
28+
29+
To install pyschlage, run this command in your terminal:
30+
31+
```sh
32+
$ pip install pyschlage
33+
```
34+
35+
### Source code
36+
37+
Pyschlage is actively developed on Github, where the code is [always available](https://github.com/dknowles2/pyschlage).
38+
39+
You can either clone the public repository:
40+
41+
```sh
42+
$ git clone https://github.com/dknowles2/pyschlage
43+
```
44+
45+
Or download the latest [tarball](https://github.com/dknowles2/pyschlage/tarball/main):
46+
47+
```sh
48+
$ curl -OL https://github.com/dknowles2/pyschlage/tarball/main
49+
```
50+
51+
Once you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:
52+
53+
```sh
54+
$ cd pyschlage
55+
$ python -m pip install .
56+
```
57+
2558
## Documentation
2659

2760
API reference can be found on [Read the Docs](https://pyschlage.readthedocs.io)

0 commit comments

Comments
 (0)