From: MikkelFJ <mikkelfj-anti-spam@...>
Date: 2003-05-27T07:22:44+09:00
Subject: Re: Project Directory Structure


"Jim Freeze" <jim@freeze.org> wrote in message
news:20030526164212.B60771@freeze.org...

> >
> > That's very close to what I use, but I've never used a src/ dir for a
> > ruby project. What's that for?

> I've seen the src directory for things like .y files.

It's widely used for C source code. There isn't really a convention for
mixed language directories,
but you might find ./ruby instead of ./src, or just source code in the
current directory (but that tends to backfire as the project grows).
One could have ./src normally and ./src/ruby, ./src/ocaml, ... for mixed
language.

> It is source that does not necessarily belong to an
> extension and is never pushed out to an install lib.

I have adopted the directory name 'exo' for external language bindings to a
project. Sane persons would normally use 'bindings'. I then have ./exo/ruby
../exo/com, ./exo/ocaml, ... . In this case where ruby is an extension to
another project, I might then adopt the suggested directory structure within
ruby: ./exo/ruby/src, ./exo/ruby/doc, ... .

> > Also, I would add RELEASE-NOTES or ChangeLog or CHANGES.

There's also INSTALL

readme.txt is friendly for windows users because you can than click directly
and open the text in notepad and sometimes it gets highlighted by file
browsers as an important file.

Mikkel