Jump to content

4. How to write a good LAVAcr readme.txt


Recommended Posts

You must include a readme.txt file inside the submitted zip file. This is important - if you submit code without a readme.txt, or with an incomplete readme.txt, it will be rejected. Users may not have access to the website (or LabVIEW) and the zip file needs to have information about the contents. This file includes a temporary link to the support topic of your submission. Once your submission is approved, you must update the link in the readme file and resubmit the zip file. Some people edit the readme file then just copy the entire contents of the file and use that in the description field of their submission - we encourage this practise as it means that everything is identical.

Please feel free to use this template to help you create your readme.txt file:

Download File:post-181-1167856654.txt

readme.txt file structure

<submission Name> Va.b.c

Include the name of your LAVAcr submission, as well as the version number. When versioning a submission, use the format Va.b.c, where the values represent the following:

  • a is the major release number - use it when releasing your first stable version, and when the functionality of the submission changes significantly.
  • b is the incremental minor revision number - use it when fixing bugs and/or upgrading minor functionality
  • c is the build number - use it when creating new builds.


Link to comment

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Create New...

Important Information

By using this site, you agree to our Terms of Use.