On Thu, 2007-07-26 at 23:17 +0200, Philipp von Weitershausen wrote: > On 18 Jul 2007, at 22:34 , Maciej Wisniowski wrote: > >> I will add this to the zopeproject docs. I wonder: > >> > >> * Would it help if the 'myzopeapp' package would not be in the > top- > >> level MyZopeApp directory, but in a 'src' directory below > >> MyZopeApp? Would that make it clearer where to go? > >> > >> * grokproject actually also creates a "hello world" browser page. > >> That way there's some initial code there and people might know > >> better where to go in and change stuff. Would that help? Or would > >> that be too much unnecessary boilerplate? > > For me, second approach is more clear but even simple README.txt, > > located at new project's folder, with description of next steps, > > should be enough. > > The problem with boilerplate README files is that they're never > changes after the fact, therefore making it look like your code has > documentation while in fact it's just the unchanged boilerplate. At > least the code *has* to be changed to make something useful out of > it.
Hmm. Perhaps both sets of requirements can be satisfied by generating a REPLACEME (or RENAMEME, or EDITME) file with the boilerplate in it. That should still help a newbie get things going while making it clear that it is not (yet) actual documentation for the new code. - Michael
signature.asc
Description: This is a digitally signed message part
_______________________________________________ Zope3-dev mailing list Zope3-dev@zope.org Unsub: http://mail.zope.org/mailman/options/zope3-dev/archive%40mail-archive.com
