LAVA Forums Buy cool LAVA gear Forums RSS Feed

Welcome Guest ( Log In | Register )

Tags
(This content has not been tagged yet)
 
Closed Topic Start new topic
> 4. How to write a good LAVAcr readme.txt, You need it, so you might as well make it a good one!
crelf
post Oct 19 2006, 10:42 PM
Post #1


I'm a LAVA, not a fighter.
******

V I Engineering, Inc.
Posts: 3740
Joined: 13-October 03
From: Michigan, USA
Member No.: 181
Using LabVIEW Since:1993
LV:8.5 ,. ,.
Australia United States Nothing Selected My Blog


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:
Attached File  LAVAcr_Template_Readme.txt ( 2.57K ) Number of downloads: 276


readme.txt file structure

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.
Copyright © 2007,
All rights reserved.

Put your real name here for the copyright to apply.

Author:


You want people to know that the submission's yours, don't you? You also need to include a means of contact for support and improvements. Although we encourage everyone to discuss the code here in the LAVAcr, users (especially those outside of LAVA) may still need to get in contact with the author directly.

Distribution:
This code was downloaded from the LAVA Code Repository: http://forums.lavag.org/downloads.html

We've got to have our own little advertisment here - to give users and idea on where to get support and to help grow our community!

Description:

Enter the same description here as in your upload page description. Feel free to add subsections including Instructions, Features, etc.

Dependancies:

List any components that the submission requires that you haven't included. Normally, you will include third party components, but for common components, please include their titles and where they are available from. For example: list all OpenG libraries and their dependancies, as well as a link to the OpenG webpage.

Support:
If you have any problems with this code or want to suggest features:
http://forums.lavag.org/forums.html####

The above link will be available after your submission has been approved. After you get this link, come back, edit this file and resubmit with the updated link.

Change Log:
1.0.1: Fixed U32 to U16 implicit conversion bug
1.0.0: Initial release of the code.

It's important to keep track of how the submission has changed over time to assist users with configuration control.

License:

The licensing of submissions is one of the most important facets of code here on the LAVAcr - it's your code, so you retain control over the license of it. As your code may be passed on to someone who didn't get it directly from the LAVAcr, the license details must travel with it - that's what this section is for.
Attached File(s)
Attached File  LAVAcr_Template_Readme.txt ( 2.22K ) Number of downloads: 264
 

--------------------


Tags
(This content has not been tagged yet)
Go to the top of the page
+Quote Post
Ad
post Oct 19 2006, 10:42 PM
Post #















Tags
(This content has not been tagged yet)
Go to the top of the page
Quote Post

Closed TopicStart new topic

 




Time is now: 22nd November 2008 - 07:23 AM