From jmg3000 at gmail.com  Sun Sep 17 17:31:25 2006
From: jmg3000 at gmail.com (John Gabriele)
Date: Sun, 17 Sep 2006 17:31:25 -0400
Subject: [Hello-talk] splitting up README
Message-ID: <65e0bb520609171431g6567ef70i793c511c4b60c6ef@mail.gmail.com>

Hi,

It looks like the README file contains various sections which might be
better off living in their own doc/foo.rdoc files. IMO, one big one to
split off would be a doc/files_and_directories.rdoc.

(Hm... wait. I just grabbed what's in svn and that "doc" directory
doesn't exist...)

Another file to start might be doc/packaging_your_project.rdoc which
could describe how to create your gem, then direct you to look at
doc/rubyforge.rdoc for more info.

Hm. The README actually currently contains some stuff about RubyForge
that is also in doc/rubyforge.rdoc.

Say, when I generate html from source and rdoc files, they land in a
directory named "doc" by default. But you've already got a "doc"
directory in the project. How do you keep the two from overlapping?
Could you please outline in the README exactly what commands you type
(and from which directory) to generate the html rdocs?

Also, what's that "hello" directory doing under the main "hello" directory?

Thanks,
---John