Skip to content

Commit

Permalink
doc: getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
dancergraham authored Nov 19, 2023
1 parent 58fee61 commit 3afa309
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,21 @@ This python library wraps the [rust e57 library](https://github.com/cry-inc/e57)

## Getting Started

We need a getting started guide - could you write one based on our tests?
`pip install e57`

```python
>>> import e57
>>> e57.read_points(r"pointcloud.e57")
array([[-23.25304444, -28.17607415, -13.44830654],
[-23.28290139, -28.02118905, -13.44237764],
[-23.26799723, -27.9039115 , -13.43430738],
...,
[ 23.2458152 , 25.4866642 , 12.45043932],
[ 23.22830673, 25.58055374, 12.49285875],
[ 23.25270363, 25.45909652, 12.54284554]])
```

We need a tutorial - could you write one based on our tests?

## Contributing

Expand Down

0 comments on commit 3afa309

Please sign in to comment.