Re: The Well Tempered Ruby Application

James Britt <[email protected]> Wed, 13 Sep 2006 17:04:20 -0700
Newsgroups gmane.comp.lang.ruby.documentation
Organization ruby-doc.org
Message-ID <[email protected]>
Tim Becker wrote:
> Hi,
> 
> I've been starting to put together a small sample project like GNU's
> "Hello" (http://www.gnu.org/software/hello/) that provides just the
> framework of everything that a well behaved Ruby project should
> contain. The project should serve a dual role of providing a template
> for new projects and as a tutorial. I've done some cursory searching,
> but I haven't found anything.

I believe the book Programming Ruby, AKA The Pickaxe, has information on 
this.  There have also been some threads on ruby-talk.  I don't recall 
much detail, but i I think certain things were vaguely contentious.

(But these may have been the usual geek minutia items, such as whether a 
directory should be called 'test' or 'tests'.)


I recently decided to refactor some utility code into better-packaged 
libraries, and since I want to gem up various parts I decided to go see 
how people structure their gem dirs.  So they might provide a sort of 
"population sample" to examine.



> ... 
> Sorry for crossposting, I thought this might not only be of interest
> for ruby-doc.
> 

Oh it is, since a guideline or template such as this should encourage 
people to write docs for the code, and give them some basic ideas for 
things such as the README  and INSTALL files, and (at least) rudimentary 
rdoc content.

(I suspect everyone on this list also follows ruby-talk,  but there's 
far less traffic here.)


James Britt