Closed spydergt1 closed 12 years ago
Every non-LightProgram class declaration now includes a comment header indicating its purpose. Use the #include statements to determine at a glance what the dependencies are.
SOAPBOX: Comments should be rare in implementation (.cpp) files. If the author considered them essential, it's either because the code was unclear and should be made clearer (common, should be fixed), or the code is expressing logic that's so intricate or necessarily fragile that a natural-language explanation is in order (rare, must be left in).
That said, it's entirely possible that this project's code falls into the former case, meaning it's written in an unreadable fashion and should be improved. I strive for that not to be the case, but if it is, let me know about specific sections of the code, and I'll rewrite them until we both agree they don't need commenting.
I hope this is not to much of a newb question but could you create an outline of which libraries build on which other libraries in the wiki or readme? And perhaps a little discription of the intent of each piece of code? It appears Program Runner includes Light Programs which includes G35. Likewise The basic example includes G35 String which includes G35. Many pieces of code are obviously effects. New to coding so I am learning as I go. I have a set of 50 lights and my arduino hooked up. Uploaded the basic example and have played around with changing the lights between the basic colors. My goal right now is to understand the code enough to create a "warm white" and some custom colors.