[Cuis-dev] Package Comments

[ken.dickey at whidbey.com]

Greetings,

I tried starting a convention with

https://github.com/Cuis-Smalltalk/Learning-Cuis/blob/master/PackageRef.md

As I learn yet again, separation of documentation and code leads to 
documentation rot.

Some thoughts on this:

  [1] I think it would be good to have a common template for a package's 
README.md, perhaps named SAMPLE_PACKAGE_README.md or some such kept in 
Cuis-Smalltalk-Dev.

  [2] I would like to see a section "Code/Techniques Of Interest to 
Programmers" (see PackageRef.md)

  [3] If some kind person has the time, it would be good to have 
something parseable which could show up in a tool for browsing packages, 
perhaps as an option.

Not that I have time to do all of this, but if anyone out there has a 
few extra cycles to spare..

$0.02,
-KenD