Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the list of packages and descriptions in CONTRUBUTING.MD #519

Merged
merged 1 commit into from
May 23, 2024
Merged

Update the list of packages and descriptions in CONTRUBUTING.MD #519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@ The source code can be found under the `Source` directory. The package definitio

## Building the LabVIEW Packages

The source code is built into three LabVIEW packages
The source code is built into five LabVIEW packages

* `ni_measurementlink_service`
* `ni_measurementlink_generator`
* `ni_measurementlink`
* `ni_measurementlink_examples`
* `ni_protobuf_types`

To build the packages:
Expand Down Expand Up @@ -79,6 +81,18 @@ The `MeasurementLink Measurement Template` library contains the VIs and controls

The `MeasurementService Editor` library contains the scripting code required to generate a measurement. It starts with the `MeasurementLink Measurement Template` as the base library and then customizes it for a specific measurement. It also contains a script that can help when updating measurements between incompatible versions. See more details [here.](docs/Upgrading%20to%20Version%202.0.md)

## `ni_measurementlink` Package

This is simply a top-level package that has dependencies on the other `ni_measurementlink_*` packages so installing this should also bring along the other 3 packages.

## `ni_measurementlink_examples` Package

This package contains all of the example projects from the repository. They are installed to the `examples` folder under the LabVIEW root directory.

## `ni_protobuf_types` Package

This package contains common types that are used in measurement plug-ins such as the Waveform and Double XY Data types.

## Examples

This repo contains example measurement services that show how to use the API with NI and 3rd party hardware. For additional details on examples, please refer to the [example measurements documentation.](Source/Example%20Measurements/README.md)
Expand Down