Skip to content

Commit 0cd91c7

Browse files
committed
Gradle: stand-alone build, independent from css4j-dist.
1 parent 106395e commit 0cd91c7

File tree

9 files changed

+673
-20
lines changed

9 files changed

+673
-20
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,8 @@
1818
*.iws
1919

2020
# Gradle
21-
/.gradle
21+
**/.gradle
2222
/build/
23+
/buildSrc/build/
24+
25+
/CHANGES.txt

README.md

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

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

5-
Please refer to the `css4j-dist` repository for build instructions.
6+
## Build from source
7+
To build css4j-dom4j from the code that is currently at the Git repository, you need a current JDK (the build is tested with
8+
version 16). You can run a variety of Gradle tasks with the Gradle wrapper (on Unix-like systems you may need to type `./gradlew`):
9+
10+
- `gradlew build` (normal build)
11+
- `gradlew build publishToMavenLocal` (to install in local Maven repository)
12+
- `gradlew copyJars` (to copy jar files into a top-level _jar_ directory)
13+
- `gradlew lineEndingConversion` (to convert line endings of top-level text files to CRLF)
14+
- `gradlew publish` (to deploy to a Maven repository, as described in the `publishing.repositories.maven` block of
15+
[build.gradle](https://github.com/css4j/css4j/blob/master/build.gradle))
16+
17+
<br/>
18+
19+
## Usage from a Gradle project
20+
If your Gradle project depends on css4j-dom4j, you can use this project's own Maven repository in a `repositories` section of
21+
your build file:
22+
```groovy
23+
repositories {
24+
maven {
25+
url "https://css4j.github.io/maven/"
26+
mavenContent {
27+
releasesOnly()
28+
}
29+
content {
30+
includeGroup 'io.sf.carte'
31+
includeGroup 'io.sf.jclf'
32+
includeGroup 'xmlpull'
33+
includeGroup 'xpp3'
34+
}
35+
}
36+
}
37+
```
38+
please use this repository **only** for the artifact groups listed in the `includeGroup` statements.
39+
40+
Then, in your `build.gradle` file:
41+
```groovy
42+
dependencies {
43+
api "io.sf.carte:css4j-dom4j:${css4jDom4jVersion}"
44+
}
45+
```
46+
where `css4jDom4jVersion` would be defined in a `gradle.properties` file.
47+
48+
<br/>
49+
50+
## Website
51+
For more information please visit https://css4j.github.io/

RELEASE_NOTES.txt

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
2+
CSS4J-DOM4J MODULE RELEASE NOTES
3+
================================
4+
5+
Release 3.6.0 - July 30, 2021
6+
-----------------------------
7+
8+
Release Highlights
9+
------------------
10+
11+
* Build improvements.
12+
13+
The Gradle build is now independent from css4j-dist.
14+
15+
16+
Description
17+
-----------
18+
This software contains Java(tm) classes that leverage the DOM4J library to use
19+
CSS4J. Unless otherwise noted, this software is provided under a BSD-style
20+
licence (see the LICENSE.txt file).
21+
22+
This css4j-dom4j module uses documents and elements that extend those of dom4j
23+
(it is intended for those who are comfortable with dom4j).
24+
25+
26+
Java(tm) Runtime Environment requirements
27+
-----------------------------------------
28+
All the classes in the binary package have been compiled with a Java compiler
29+
set to 1.8 compiler compliance level, except the module-info file.
30+
31+
Building the library requires JDK 15 or higher, although the resulting jar
32+
files can be run with a 1.8 JRE.
33+
34+
35+
Software dependencies
36+
=====================
37+
38+
To build this library you need:
39+
40+
- The css4j artifact (and its transitive dependencies); version 3.6.0 or higher
41+
is recommended (compatibility with 4.0 or higher is not guaranteed):
42+
https://github.com/css4j/css4j/releases
43+
44+
- The css4j-agent artifact; version 3.6.0 or higher is recommended
45+
(compatibility with 4.0 or higher is not guaranteed):
46+
https://github.com/css4j/css4j-agent/releases
47+
It is optional at runtime.
48+
49+
- The dom4j JAR package (tested with 2.1.1). Requires at least version 2.0 to
50+
compile and 2.1.1 to run the tests, but you should be able to run the
51+
resulting jar file with dom4j 1.6 if you are stuck with it.
52+
URL: https://github.com/dom4j
53+
54+
- The XPP3 Pull Parser (which is supported by this library but beware that it
55+
does not support entities). See:
56+
https://github.com/xmlpull-xpp3/xmlpull-xpp3
57+
58+
59+
Optional packages (required for tests):
60+
61+
- A recent version of JUnit 4.
62+
63+
- Jaxen (https://github.com/jaxen-xpath/jaxen), this software was tested with
64+
version 1.2.0.
65+
66+
- The SLF4J package, which is a logging package. See http://www.slf4j.org/
67+
for more information.
68+
69+
70+
Project Sites
71+
=============
72+
Project home: https://css4j.github.io/
73+
Development site: https://github.com/css4j/css4j-dom4j

0 commit comments

Comments
 (0)