You're welcome to crib from Syndication, it's a fairly simple
pure-ruby project, and I've tried to keep the rakefile clean and
automate as much as possible.
http://rubyforge.org/projects/syndication
I have examples/ html/ lib/ pkg/ and test/. html/ is generated by
Rdoc, the rest are part of the distributed code. Obviously
applications would have app/ or bin/ or something like that.
As well as the usual README, I have:
CHANGES -- change log
IMPLEMENTATION -- implementation notes for people curious about how
and why things were done the way they were
DEVELOPER -- notes about version control, tagging, and other stuff
people need to know to hack on the code
Also, to be cranky for a moment, I'd like to suggest a few rules I
wish every Ruby programmer had to follow:
1. Don't set up a RubyForge project until you have some releasable code.
(It seems like about half the projects on RubyForge are dead ones that
have never released anything, and it makes searching for actual code a
pain.)
2. You haven't got releasable code until you have documentation for it.
3. Putting up a wiki saying "Please write some documentation for me"
does not constitute documentation.
4. You haven't finished setting up your RubyForge project until the
Project Home Page link points at some useful information about what
the project is and what it does, and the Docs tab has a link to the
actual documentation.
mathew
|
