blob: 9ad0dc0e39a24b11eefa7edd18ccf618623c8951 [file] [log] [blame]
/* Copyright 2004 The Apache Software Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
Welcome to XMLBeans!
Layout of the tree:
- README.txt this file
- build.xml ant build file for building XmlBeans code and utilities
- STATUS essential info about the project
- xbeanenv.cmd sets the XMLBEANS_HOME environment variable on Windows
- sets the XMLBEANS_HOME environment variable on Unix
- bin contains useful command-line scripts for Win and Unix
- docs contains several documentation files
- javadocs API documentation
- maven-plugin source and documentation on using the xmlbeans2 Maven plugin
- samples contains ... samples
- src the source code for XmlBeans, organized by area
- test contains test cases and infrastructure
- xkit contains the README file for the binary distribution
To quickly get started run:
"ant" to build XmlBeans or
"ant usage" to see the most useful build targets or
"cd bin" and then "<tool_name> -help" for a description of what the
tool does and what parameters it accepts
For further information check out:
./samples/<sample_name>/README.txt for running samples
./test/docs/* for running tests
XmlBeans depends on the following external libraries:
- slf4j-api [] for logging
- javaparser-core (O) []
- Saxon-HE (O) []
for XPath/XQuery in XmlBeans
(O) means that the library is optional
For licensing information, see ./src/license/LICENSE.txt
Updated: 3/22/2019.