Skip to content

Commit 0462491

Browse files
committed
Refactor README and RELEASE_NOTES for 3.6.1 release.
1 parent e8e24ea commit 0462491

File tree

3 files changed

+82
-75
lines changed

3 files changed

+82
-75
lines changed

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
# css4j - dom4j module
22

33
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/>
516

617
## 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+
821
You can run a variety of Gradle tasks with the Gradle wrapper (on Windows shells you can omit the `./`):
922

1023
- `./gradlew build` (normal build)
@@ -47,5 +60,41 @@ where `css4jDom4jVersion` would be defined in a `gradle.properties` file.
4760

4861
<br/>
4962

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+
5099
## Website
51100
For more information please visit https://css4j.github.io/

RELEASE_NOTES.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# css4j-dom4j version 3.6.1 Release Notes
2+
3+
### November 28, 2021
4+
5+
<br/>
6+
7+
## Release Highlights
8+
9+
### DOM conformance.
10+
11+
- `XHTMLDocument` has gained `getCompatMode()`.
12+
13+
- `XHTMLDocument` now returns sane default values for `Document.inputEncoding`,
14+
`xmlEncoding`, `xmlStandalone` and `xmlVersion` attributes (instead of throwing an
15+
exception). Thanks to that, css4j-dom4j documents can now be used with a
16+
wider XML infrastructure like `javax.xml.transform.Transformer`.
17+
18+
### Build & CI.
19+
20+
- Miscellaneous build improvements.
21+
22+
- Added a CI workflow.
23+
24+
- New workflow to automatically publish in Github packages on release.
25+
26+
27+
## Project Sites
28+
29+
Project home: https://css4j.github.io/
30+
31+
Development site: https://github.com/css4j/css4j-dom4j

RELEASE_NOTES.txt

Lines changed: 0 additions & 73 deletions
This file was deleted.

0 commit comments

Comments
 (0)