ni / niveristand-communications-bus-template

Template custom device for using communications buses in VeriStand
http://www.ni.com
MIT License
0 stars 3 forks source link

Add developer guide #71

Closed buckd closed 3 years ago

buckd commented 3 years ago

What does this Pull Request accomplish?

Adds documentation about code architecture and usage for developers contributing to the template.

Note: This document does not provide information on using the template to create a new custom device. That information will be covered in another document (user guide).

Why should this Pull Request be merged?

It is useful to have some documentation explaining the template architecture, especially since this template uses a new paradigm of using packed project libraries to contain device- and protocol-specific code called by the main LLBs required by VeriStand custom devices.

What testing has been done?

None.

buckd commented 3 years ago

If it would be useful to include the built-in commands and pages supported by the template, I can add those, but feel that might be more useful in a user guide.

Also, I'm linking to the existing steps for cloning the template until we have a utility that accomplishes this for us and we can remove that document in favor of the user guide.