Skip to content

Commit 3afa309

Browse files
authored
doc: getting started
1 parent 58fee61 commit 3afa309

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,21 @@ This python library wraps the [rust e57 library](https://github.com/cry-inc/e57)
1414

1515
## Getting Started
1616

17-
We need a getting started guide - could you write one based on our tests?
17+
`pip install e57`
18+
19+
```python
20+
>>> import e57
21+
>>> e57.read_points(r"pointcloud.e57")
22+
array([[-23.25304444, -28.17607415, -13.44830654],
23+
[-23.28290139, -28.02118905, -13.44237764],
24+
[-23.26799723, -27.9039115 , -13.43430738],
25+
...,
26+
[ 23.2458152 , 25.4866642 , 12.45043932],
27+
[ 23.22830673, 25.58055374, 12.49285875],
28+
[ 23.25270363, 25.45909652, 12.54284554]])
29+
```
30+
31+
We need a tutorial - could you write one based on our tests?
1832

1933
## Contributing
2034

0 commit comments

Comments
 (0)