Skip to content

Commit

Permalink
Refactor README and RELEASE_NOTES for 3.6.1 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosame committed Nov 28, 2021
1 parent e8e24ea commit 0462491
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 75 deletions.
53 changes: 51 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
# css4j - dom4j module

Subclasses several [dom4j](https://dom4j.github.io/) classes and provides CSS functionality to it.
Licence is BSD 3-clause.

[License](LICENSE.txt) is BSD 3-clause.

See the [latest Release Notes](RELEASE_NOTES.md).

## Java™ Runtime Environment requirements
All the classes in the binary package have been compiled with a [Java compiler](https://adoptium.net/)
set to 1.8 compiler compliance level, except the `module-info.java` file.

Building the library requires JDK 11 or higher.

<br/>

## Build from source
To build css4j-dom4j from the code that is currently at the Git repository, Java 11 or later is needed.
To build css4j-dom4j from the code that is currently at the Git repository, Java
11 or later is needed, although the resulting jar files can be run with a 1.8 JRE.

You can run a variety of Gradle tasks with the Gradle wrapper (on Windows shells you can omit the `./`):

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

<br/>

## Software dependencies

In case that you do not use a Gradle or Maven build (which would manage the
dependencies according to the relevant `.module` or `.pom` files), the required
and optional library packages are the following:

### Compile-time dependencies

- The [css4j](https://github.com/css4j/css4j/releases) library (and its transitive
dependencies); version 3.6.1 or higher is recommended (compatibility with 4.0 or
higher is not guaranteed):

- The [css4j-agent](https://github.com/css4j/css4j-agent/releases) library;
version 3.6.0 or higher is recommended (compatibility with 4.0 or higher is
not guaranteed). **It is optional at runtime.**

- The [dom4j](https://github.com/dom4j/dom4j) JAR package (tested with 2.1.1).
Requires at least version 2.0 to compile and 2.1.1 to run the tests, but you
should be able to run the resulting jar file with dom4j 1.6 if you are stuck with it.

- The [XPP3 Pull Parser](https://github.com/xmlpull-xpp3/xmlpull-xpp3) (which
can be used with this library but beware that it does not support [character
entities](https://dev.w3.org/html5/html-author/charref)).
**It is optional at runtime.**

### Test dependencies

- A recent version of [JUnit 4](https://junit.org/junit4/).

- [Jaxen](https://github.com/jaxen-xpath/jaxen), this software was tested with
version 1.2.0.

- [SLF4J](http://www.slf4j.org/), which is a logging package.

<br/>

## Website
For more information please visit https://css4j.github.io/
31 changes: 31 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# css4j-dom4j version 3.6.1 Release Notes

### November 28, 2021

<br/>

## Release Highlights

### DOM conformance.

- `XHTMLDocument` has gained `getCompatMode()`.

- `XHTMLDocument` now returns sane default values for `Document.inputEncoding`,
`xmlEncoding`, `xmlStandalone` and `xmlVersion` attributes (instead of throwing an
exception). Thanks to that, css4j-dom4j documents can now be used with a
wider XML infrastructure like `javax.xml.transform.Transformer`.

### Build & CI.

- Miscellaneous build improvements.

- Added a CI workflow.

- New workflow to automatically publish in Github packages on release.


## Project Sites

Project home: https://css4j.github.io/

Development site: https://github.com/css4j/css4j-dom4j
73 changes: 0 additions & 73 deletions RELEASE_NOTES.txt

This file was deleted.

0 comments on commit 0462491

Please sign in to comment.