Skip to content

Commit 1f67ae0

Browse files
author
Bennett Goble
committed
Add basic development instructions
1 parent 8f5faba commit 1f67ae0

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Official python serialization library for [Linden Lab Structured Data (LLSD)][llsd].
66

7-
# Use
7+
## Use
88

99
Install **llsd** with pip:
1010
```
@@ -36,5 +36,27 @@ data = llsd.parse(data_binary)
3636
# >>> {'foo: 'bar'}
3737
```
3838

39+
## Develop
40+
41+
Requirements:
42+
43+
- [pre-commit](https://pre-commit.com/)
44+
45+
Set up a venv and install development dependencies:
46+
```
47+
python3 -m venv .venv
48+
. .venv/bin/activate
49+
pip install .[dev]
50+
```
51+
52+
Run tests:
53+
```
54+
pytest
55+
```
56+
57+
### Benchmarks
58+
59+
Benchmarks from commits to `main` are published [here](https://secondlife.github.io/python-llsd/dev/bench/).
60+
3961
[llsd]: https://wiki.secondlife.com/wiki/LLSD
4062
[llbase]: https://pypi.org/project/llbase/

0 commit comments

Comments
 (0)