¿ªÔÆÌåÓý

Version Control


 

As the "Flutter Fix" topic seems to be getting pretty wide, I thought it would be good to focus a little more closely on the version control issue.

Here's a sample of the header block I use on my code files:


// Name:?? ??? ? ? ? ?? ADS9850DDS.ino
// Author:?? ??? ??????? James M. Lynes, Jr.
// Created:?? ??? ????? February 26, 2015
// Modified By:?? ??? James M. Lynes, Jr.
// Last Modified:?? ?January 31, 2017
// Change Log:?? ??? 2/26/2015 - Program Created
//??????????????????????????? 1/29/2017 - Change Default Frequency, allow tuning via serial terminal
//?? ??? ??? ???????????????? 1/31/2017 - Add Band edge checking, tuning rate change command
//
// Description:?? ??? ?Test Sketch to drive an AD9850 DDS Module
//?? ??? ??? ?? ? ? ? ? ? ? ? Basically a 40 meter VFO
//

Sections could be added for Development Environment, Libraries, Minimum Hardware Requirements, etc.

As individual hardware configurations? vary from the delivered product, the software is unlikely to be plug and play. Good documentation will be important.


James



Join [email protected] to automatically receive all group messages.