|
1 | 1 | # css4j - dom4j module |
2 | 2 |
|
3 | 3 | Subclasses several [dom4j](https://dom4j.github.io/) classes and provides CSS functionality to it. |
4 | | -Licence is BSD 3-clause. |
| 4 | + |
| 5 | +[License](LICENSE.txt) is BSD 3-clause. |
| 6 | + |
| 7 | +See the [latest Release Notes](RELEASE_NOTES.md). |
| 8 | + |
| 9 | +## Java™ Runtime Environment requirements |
| 10 | +All the classes in the binary package have been compiled with a [Java compiler](https://adoptium.net/) |
| 11 | +set to 1.8 compiler compliance level, except the `module-info.java` file. |
| 12 | + |
| 13 | +Building the library requires JDK 11 or higher. |
| 14 | + |
| 15 | +<br/> |
5 | 16 |
|
6 | 17 | ## Build from source |
7 | | -To build css4j-dom4j from the code that is currently at the Git repository, Java 11 or later is needed. |
| 18 | +To build css4j-dom4j from the code that is currently at the Git repository, Java |
| 19 | +11 or later is needed, although the resulting jar files can be run with a 1.8 JRE. |
| 20 | + |
8 | 21 | You can run a variety of Gradle tasks with the Gradle wrapper (on Windows shells you can omit the `./`): |
9 | 22 |
|
10 | 23 | - `./gradlew build` (normal build) |
@@ -47,5 +60,41 @@ where `css4jDom4jVersion` would be defined in a `gradle.properties` file. |
47 | 60 |
|
48 | 61 | <br/> |
49 | 62 |
|
| 63 | +## Software dependencies |
| 64 | + |
| 65 | +In case that you do not use a Gradle or Maven build (which would manage the |
| 66 | +dependencies according to the relevant `.module` or `.pom` files), the required |
| 67 | +and optional library packages are the following: |
| 68 | + |
| 69 | +### Compile-time dependencies |
| 70 | + |
| 71 | +- The [css4j](https://github.com/css4j/css4j/releases) library (and its transitive |
| 72 | + dependencies); version 3.6.1 or higher is recommended (compatibility with 4.0 or |
| 73 | + higher is not guaranteed): |
| 74 | + |
| 75 | +- The [css4j-agent](https://github.com/css4j/css4j-agent/releases) library; |
| 76 | + version 3.6.0 or higher is recommended (compatibility with 4.0 or higher is |
| 77 | + not guaranteed). **It is optional at runtime.** |
| 78 | + |
| 79 | +- The [dom4j](https://github.com/dom4j/dom4j) JAR package (tested with 2.1.1). |
| 80 | + Requires at least version 2.0 to compile and 2.1.1 to run the tests, but you |
| 81 | + should be able to run the resulting jar file with dom4j 1.6 if you are stuck with it. |
| 82 | + |
| 83 | +- The [XPP3 Pull Parser](https://github.com/xmlpull-xpp3/xmlpull-xpp3) (which |
| 84 | + can be used with this library but beware that it does not support [character |
| 85 | + entities](https://dev.w3.org/html5/html-author/charref)). |
| 86 | + **It is optional at runtime.** |
| 87 | + |
| 88 | +### Test dependencies |
| 89 | + |
| 90 | +- A recent version of [JUnit 4](https://junit.org/junit4/). |
| 91 | + |
| 92 | +- [Jaxen](https://github.com/jaxen-xpath/jaxen), this software was tested with |
| 93 | + version 1.2.0. |
| 94 | + |
| 95 | +- [SLF4J](http://www.slf4j.org/), which is a logging package. |
| 96 | + |
| 97 | +<br/> |
| 98 | + |
50 | 99 | ## Website |
51 | 100 | For more information please visit https://css4j.github.io/ |
0 commit comments