Skip to content

Commit 153cd3c

Browse files
committed
Update readme
1 parent 569cf78 commit 153cd3c

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,30 @@
55
This repository contains protocol definitions for interacting with the Blueye underwater drones.
66

77
## Protocol v2
8+
89
Drones running a Blunux version \< 3.0 will need to use the legacy protocol. [blueye.legacyprotocol](https://github.com/BluEye-Robotics/blueye.legacyprotocol) contains a Python package that is built on this protocol and simplifies its use.
910

1011
## Protocol v3
12+
1113
Version 3 of the Blueye communication protocol is based on [Protocol Buffers](https://developers.google.com/protocol-buffers).
1214

13-
The protobuf definitions are compiled to language specific libraries, and are available as a [NuGet package](https://github.com/BluEye-Robotics/ProtocolDefinitions/packages/1239508) and a [Python package](https://pypi.org/project/blueye.protocol/).
15+
The protobuf definitions are compiled to language specific libraries, and are available as a [NuGet package](https://github.com/BluEye-Robotics/ProtocolDefinitions/packages/1239508), [Python package](https://pypi.org/project/blueye.protocol/) and a [npm package](https://www.npmjs.com/package/@blueyerobotics/protocol-definitions).
1416

1517
Automatically generated documentation for the protocol format can be found [here](https://blueyebuildserver.blob.core.windows.net/protocoldefinitions/docs/protocol.html).
1618

1719
### Installation
20+
1821
#### OS X
22+
1923
```
2024
make
2125
make install PREFIX=/usr/local
2226
```
2327

2428
### Uninstall
29+
2530
#### OS X
31+
2632
```
2733
make uninstall PREFIX=/usr/local
2834
```

0 commit comments

Comments
 (0)