<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body dir="auto"><div dir="ltr"></div><div dir="ltr">Below</div><div dir="ltr"><br>On Apr 25, 2019, at 1:36 PM, Phil B via Cuis-dev <<a href="mailto:cuis-dev@lists.cuis.st">cuis-dev@lists.cuis.st</a>> wrote:<br><br></div><blockquote type="cite"><div dir="ltr"><div dir="auto">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.</div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Apr 25, 2019, 4:26 PM ken.dickey--- via Cuis-dev <<a href="mailto:cuis-dev@lists.cuis.st">cuis-dev@lists.cuis.st</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">In taking steps to better documentation, I would appreciate better repo <br>
ReadMe files.<br>
<br>
Note that I am not always good at this myself!<br>
<br>
When I look in a repo Foo, I am seeing things like:<br>
<br>
Port of FooQ2 library to Cuis Smalltalk<br>
<br>
Actually stating some purpose in life would be quite helpful.<br>
<br>
What does package <a href="http://Foo.pck.st" rel="noreferrer noreferrer" target="_blank">Foo.pck.st</a> do?<br>
<br>
How would I use it? Where would I look to find out? (e.g. class name)<br>
<br>
<br>
Thanks a bunch!<br>
-KenD<br>
-- <br>
Cuis-dev mailing list<br>
<a href="mailto:Cuis-dev@lists.cuis.st" target="_blank" rel="noreferrer">Cuis-dev@lists.cuis.st</a><br>
<a href="https://lists.cuis.st/mailman/listinfo/cuis-dev" rel="noreferrer noreferrer" target="_blank">https://lists.cuis.st/mailman/listinfo/cuis-dev</a><br>
</blockquote></div>
</div></blockquote><blockquote type="cite"><div dir="ltr"><span>-- </span><br><span>Cuis-dev mailing list</span><br><span><a href="mailto:Cuis-dev@lists.cuis.st">Cuis-dev@lists.cuis.st</a></span><br><span><a href="https://lists.cuis.st/mailman/listinfo/cuis-dev">https://lists.cuis.st/mailman/listinfo/cuis-dev</a></span><br></div></blockquote><br><div>If someone made a list of things that need better or updated documentation, I can dig in, investigate, talk to people etc and write some updated words. I’d have the advantage of “fresh eyes” in the sense that things have changed a lot since I was last in the loop.</div><div><br></div><div>It’ll help me catch up on the state of things in the system while I’m at it. Seems win/win, so I’m game to give it a shot. Doesn’t need to be limited to repo README stuff either. What’s in the image seems fair game too.</div><div><br></div><div>—Casey</div></body></html>