search

LabVIEW-DCAF / DCAF-Project-Templates

Sample projects used to generate modules, engines, and editors
https://decibel.ni.com/content/projects/reference-designs-for-distributed-control-systems
Other
5 stars 0 forks source link

Add 'Read Me' to generated project files #24

Open pollockm opened 8 years ago

pollockm commented 8 years ago

The project files we generate when creating modules and engines can be a bit daunting for someone unfamiliar with the framework (what should they edit, what should they not touch, etc). I'd like to see some kind of document get scripted into the project (a read me or similar) to guide a n00b to where they need to go.

smithed commented 8 years ago

thats what the bookmarks are supposed to be for :( The bookmarks even take you to the right place in the code.

pollockm commented 8 years ago

Alas, users often do not think to look in the bookmark manager. Even if the read me is 'use the bookmark manager to find where you need to edit the code' that could be enough.

becega commented 6 years ago

@pollockm We have more online documentation and a developer guide. Probably this is not required any more, as the readme would be a stale document on the template.