Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsWhite Papers
Discussion GroupsFirst AidDatabasesJavaBeansGUIJava 3DVirtual MachineCORBASecurityToolsGeneral
Java DirectoryOpen Source ProjectsSample Book ChaptersUser GroupsWeb Resources
Related Topics
Databases.NETMore Topics ...

Java Forum / General / February 2006

Tip: Looking for answers? Try searching our database.

"best practices" for a Java SDK packaging contents/structure ?

Thread view: 
Chris Markle - 09 Feb 2006 06:21 GMT
Folks,

Wondering what "best practices" are for packaging form of a Java SDK...
I was thinking about including a jar file and javadoc yielding something
approximately like this:

my-sdk/
|-- my_sdk.tar
|-- readme.txt
|-- license.txt
`-- apidocs/

I could throw things like source (it's open source) and xref'd source if
that's helpful, but it makes the download bigger. Or I could build
different kinds of distros - e.g., one being the above and another being
more full src and build oriented.

What do people think is right or best here?

Chris
Ranganath Kini - 09 Feb 2006 07:01 GMT
In my opinion the best structure of packaging your application is:

your-app/
  |---------- bin/           // contains launcher such as a .BAT or
shell script
  |---------- lib/            // contains all JAR libraries related to
your application
               |---------- myApp.jar       // the JAR containing the
main class of ur app
  |---------- docs/        // the JavaDocs pages containing
documentation
  |---------- src/          // the source code of ur app if ur open
sourcing ur app
  |---------- license.txt
  |---------- readme.txt

Hope it helps!
Chris Uppal - 09 Feb 2006 12:33 GMT
> Wondering what "best practices" are for packaging form of a Java SDK...
> I was thinking about including a jar file and javadoc yielding something
> approximately like this:

I suggest following the pattern of a Sun JDK as closely as makes sense for your
implementation.  Even going as far as emulating the JDK/JRE distinction.  The
point is that everyone (who knows how to navigate a JDK at all) will be
familiar
with the Sun layout, so they (and any tools they use) will adapt most easily to
your stuff if it follows the established pattern.

(Which, btw, would imply the use of zip files in preference to tar or tgz
archives -- that may be going too far for you, though ;-)

   -- chris


Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2008 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.