Skip to content

Commit eb7daa8

Browse files
committed
Update readme
1 parent bfc3334 commit eb7daa8

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
# VL53L1X-C-API-Pico
22
VL53L1X Time-of-Flight distance sensor API for the Raspberry Pi Pico/Pico W
33

4-
#### Notice: this library is in-progress
5-
- Please feel free to contribute to this library.
6-
- Major issues:
7-
- i2c communiucation with the VL53L1X hangs up in several steps (booting, starting ranging, etc.). This can be mitigated, albeit not solved, by adding delays.
4+
### Some features of this API are still in progress, but basic measurements work.
85

96
## Usage
107
See the examples for usage. To build the project, run the following:
118
```
129
mkdir build
1310
cd build
14-
cmake .. -DPICO_BOARD=pico_w
11+
cmake ..
1512
make
1613
```
14+
If you have a Pico W, append `-DPICO_BOARD=pico_w` to the `cmake` command.
1715

1816
The resulting uf2 files to upload to the Pico board reside in the build/examples directory.
1917

0 commit comments

Comments
 (0)