Skip to content

Commit ce91811

Browse files
committed
Prepare version 4: use Markdown in Release Notes, move non-release information to README.
1 parent ccc325a commit ce91811

File tree

4 files changed

+65
-51
lines changed

4 files changed

+65
-51
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ This software is provided under a [BSD-style license](LICENSE.txt).
1414

1515
<br/>
1616

17+
## Java™ Runtime Environment requirements
18+
19+
All the classes in the binary package have been compiled with a [Java compiler](https://adoptium.net/)
20+
set to 1.8 compiler compliance level, except the `module-info.java` file.
21+
22+
Building this library requires JDK 11 or higher.
23+
24+
<br/>
25+
1726
## Building from source
1827

1928
### Requirements
@@ -58,3 +67,30 @@ Before deploying to a remote Maven repository, please read the
5867
to learn which properties you need to set (like `mavenReleaseRepoUrl`or
5968
`mavenRepoUsername`), either at the [command line](https://docs.gradle.org/current/userguide/build_environment.html#sec:project_properties)
6069
(`-P` option) or your `GRADLE_USER_HOME/gradle.properties` file.
70+
71+
<br/>
72+
73+
## Software dependencies
74+
75+
In case that you do not use a Gradle or Maven build (which would manage the
76+
dependencies according to the relevant `.module` or `.pom` files), the required
77+
and optional library packages are the following:
78+
79+
### Compile-time dependencies
80+
81+
- The [carte-util](https://github.com/css4j/carte-util) library; version 3.5.1
82+
or higher is recommended.
83+
84+
- The [jclf-text](https://jclf.sourceforge.io/api/io.sf.jclf.text/module-summary.html)
85+
(5.0.0 or higher) module. See: https://sourceforge.net/projects/jclf
86+
87+
**It is optional at runtime.**
88+
89+
- The [tokenproducer](https://github.com/css4j/tokenproducer) library; version
90+
1.1.1 or higher is recommended.
91+
92+
**It is optional at runtime.**
93+
94+
### Test dependency
95+
96+
- A recent version of [JUnit 4](https://junit.org/junit4/).

RELEASE_NOTES.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# xml-dtd version 4.0.0 Release Notes
2+
3+
### December 3, 2021
4+
5+
<br/>
6+
7+
## Highlights
8+
9+
### Removal of DefaultEntityResolver.resolveEntity(String)
10+
11+
See issue #1.
12+
13+
### Use the Security Manager if available
14+
15+
See issue #2.
16+
17+
## Detail of changes
18+
19+
- Remove `DefaultEntityResolver.resolveEntity(String)`. (#1)
20+
- Use the Security Manager only if available. (#2)
21+
- Gradle: copy licensing files to `META-INF` directory of archive files.
22+
- Gradle: line-ending conversion task now warns if file does not exists.
23+
- Gradle: upgrade wrapper to 7.3.
24+
- Upgrade to JUnit 4.13.2.
25+
- Add a 'changes.sh' script to generate a CHANGES.txt.
26+
- Use Markdown in Release Notes, move non-release information to README.
27+
- README: add a link to the resolver overview/introduction page.
28+
- CI: build with Java 11 and 17.

RELEASE_NOTES.txt

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

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ group = 'io.sf.carte'
77

88
description = 'xml-dtd'
99

10-
version = '3.5.2'
10+
version = '4.0.0'
1111

1212
sourceSets {
1313
main {

0 commit comments

Comments
 (0)