Library/application packaging

ruby-talk
1

Hello,

I’m trying to get a library ready for release, so I have a question:

Is there a document describing what is “best practice” for developing a
packaged up library for distribution on the RAA/

eg:

  • documentation formats / layout for RD
  • files that should be included eg. README etc
  • the installation mechanism

I have pulled apart a few distributions from the RAA, and there doesn’t appear
to be a lot of consistency with file names? For example install.rb vs
setup.rb, and so on.

Anyone?

Cheers.

2

Hello,

I’m trying to get a library ready for release, so I have a question:

Is there a document describing what is “best practice” for
developing a packaged up library for distribution on the RAA/

Take a look at http://www.rubygarden.org/ruby?QuickGuideToPackaging.
And also http://www.rubygarden.org/ruby?QuickGuideToRaaInstall.

eg:

  • documentation formats / layout for RD
  • files that should be included eg. README etc
  • the installation mechanism

I have pulled apart a few distributions from the RAA, and there
doesn’t appear to be a lot of consistency with file names? For
example install.rb vs setup.rb, and so on.

There probably isn’t a lot of consistency. The above documents will
give some good guidance on structure, mechanisms, etc. However, no
document is perfect, and you’d best re-examine the packages you’ve
pulled apart to see what guidelines have been followed, what makes
sense, and so on.

Good luck!

Gavin

···

On Thursday, January 16, 2003, 1:16:55 AM, Piers wrote: