Skip to content

Commit 789d1e7

Browse files
committed
Clarify .NET install instructions
1 parent a25a84d commit 789d1e7

1 file changed

Lines changed: 22 additions & 6 deletions

File tree

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,31 @@ the bridge-advertised CDR schemas.
3939

4040
## Install
4141

42-
Reference the project directly:
42+
### From Source
4343

4444
```bash
45-
dotnet add package FoxgloveRosSharp
45+
git clone https://github.com/noah-wardlow/foxglove-ros-sharp.git
46+
dotnet add reference foxglove-ros-sharp/src/FoxgloveRosSharp/FoxgloveRosSharp.csproj
47+
```
48+
49+
### From a Local NuGet Package
50+
51+
Build a `.nupkg`:
52+
53+
```bash
54+
dotnet pack src/FoxgloveRosSharp/FoxgloveRosSharp.csproj --configuration Release --output artifacts
55+
```
56+
57+
Then install it into another .NET project from that local folder:
58+
59+
```bash
60+
dotnet add package FoxgloveRosSharp --source /absolute/path/to/foxglove-ros-sharp/artifacts
4661
```
4762

48-
Or from source:
63+
### From NuGet
4964

5065
```bash
51-
dotnet add reference path/to/foxglove-ros-sharp/src/FoxgloveRosSharp/FoxgloveRosSharp.csproj
66+
dotnet add package FoxgloveRosSharp
5267
```
5368

5469
## Connect
@@ -210,8 +225,9 @@ Existing ROS# generated message classes can be reused when they expose
210225
`public const string RosMessageName`.
211226

212227
Topic and service responses are decoded from Foxglove CDR payloads using the
213-
schemas advertised by the bridge. Publishing uses CDR when a matching schema has
214-
been advertised and falls back to JSON otherwise.
228+
schemas advertised by the bridge. Publishing uses Foxglove client channels: it
229+
sends CDR when a matching schema has been advertised, otherwise it sends a
230+
JSON-encoded message payload.
215231

216232
The CDR codec handles ROS 2 encapsulation-header-relative alignment, including
217233
8-byte aligned fields such as `float64[]` in `sensor_msgs/msg/JointState`.

0 commit comments

Comments
 (0)