[Cuis-dev] README.md Documentation

[Phil B]

Agreed (I'm guilty of that too). Also, a lot of that content should also be
in the package description to make it easier to find in-image.

On Thu, Apr 25, 2019, 4:26 PM ken.dickey--- via Cuis-dev <
cuis-dev at lists.cuis.st> wrote:

> In taking steps to better documentation, I would appreciate better repo
> ReadMe files.
>
> Note that I am not always good at this myself!
>
> When I look in a repo Foo, I am seeing things like:
>
>    Port of FooQ2 library to Cuis Smalltalk
>
> Actually stating some purpose in life would be quite helpful.
>
>    What does package Foo.pck.st do?
>
>    How would I use it?  Where would I look to find out? (e.g. class name)
>
>
> Thanks a bunch!
> -KenD
> --
> Cuis-dev mailing list
> Cuis-dev at lists.cuis.st
> https://lists.cuis.st/mailman/listinfo/cuis-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.cuis.st/mailman/archives/cuis-dev/attachments/20190425/6a42d54e/attachment.html>