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.

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

Update Readme to include dependency list #34

Merged
merged 2 commits into from
Aug 26, 2021
Merged
Changes from 1 commit
Commits
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
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# niveristand-custom-device-wizard
# NI VeriStand Custom Device Wizard

This project template is a consolidated version of pre-existing project templates for creating custom devices. It includes the following templates:

Expand All @@ -9,8 +9,23 @@ This project template is a consolidated version of pre-existing project template
- Inline Timing and Sync
- Asynchronous Timing and Sync

The scripting code uses a LV Class-based design that allows you to easily add support for creating new custom device project templates.
The scripting code uses a LabVIEW Class-based design that allows you to easily add support for creating new custom device project templates.

## Using niveristand-custom-device-wizard
## Dependencies

See [CONTRIBUTING.md](./CONTRIBUTING.md) for usage instructions.
- [VeriStand 2017 or later](https://www.ni.com/ro-ro/support/downloads/software-products/download.veristand.html#382072)
- [LabVIEW 2017 or later](https://www.ni.com/en-us/support/downloads/software-products/download.labview.html#411240)
- [VeriStand Custom Device Development Tools](https://github.com/ni/niveristand-custom-device-development-tools)
- Latest [released package](https://github.com/ni/niveristand-custom-device-development-tools/releases)
Karl-G1 marked this conversation as resolved.
Show resolved Hide resolved
- [HTML Workshop](https://github.com/ni/niveristand-custom-device-development-tools#external)
Karl-G1 marked this conversation as resolved.
Show resolved Hide resolved
- [Latest release of the Custom Device Wizard](https://github.com/ni/niveristand-custom-device-wizard/releases)

## Git History & Rebasing Policy

Branch rebasing and other history modifications will be listed here, with several notable exceptions:
- Branches prefixed with `dev/` may be rebased, overwritten, or deleted at any time.
- Pull requests may be squashed on merge.

## License

The NI VeriStand Custom Device Wizard is licensed under an MIT-style license (see LICENSE). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.