[hibernate-issues] [Hibernate-JIRA] Created: (HHH-3048) README.TXT in /libs poorly organized

[Porter Woodward (JIRA)]

README.TXT in /libs poorly organized
------------------------------------

                 Key: HHH-3048
                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HHH-3048
             Project: Hibernate3
          Issue Type: Improvement
          Components: documentation
    Affects Versions: 3.2.5
         Environment: Hibernate 3.2.5
            Reporter: Porter Woodward
            Priority: Minor
         Attachments: _README.txt

While the README.TXT of the /libs directory does contain some hinting about required/optional jar files needed to successfully build/run an application that leverages the Hibernate APIs - it is extemely poorly organized.

It should really have a couple of sections:

Minimal:
  List of the minimal, key Jar files needed to make Hibernate work in a no-frills way.

Cache Configuration A:
  List of additional Jars for people using a particular cache config.

Cache Configuration B:
  Ditto

Java 1.4 Configuration:
  List of Jar files needed for Java 1.4 usage...

Etc.

Instead the listing of Jar files is relatively ad-hoc, with no real indication of what Jar files go together and _why_.   For instance the optional / required if you're using Treecache jars are scattered throughout the file.  That makes it difficult to discern which Jar files are really needed for what.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira