Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 2.75 KB

README.md

File metadata and controls

88 lines (64 loc) · 2.75 KB
Raw

css4j - agent module

This provides user agent-related functionality to CSS4J.

License is BSD 3-clause, but includes a file with another license (see NOTICE.txt).


Java™ Runtime Environment requirements

All the classes in the binary package have been compiled with a Java compiler set to 1.8 compiler compliance level, except the module-info.java file.

Building this module requires JDK 11 or higher.


Build from source

To build css4j-agent from the code that is currently at the Git repository, Java 11 or later is needed. You can run a variety of Gradle tasks with the Gradle wrapper (on Windows shells you can omit the ./):

  • ./gradlew build (normal build)
  • ./gradlew build publishToMavenLocal (to install in local Maven repository)
  • ./gradlew lineEndingConversion (to convert line endings of top-level text files to CRLF)
  • ./gradlew publish (to deploy to a Maven repository, as described in the publishing.repositories.maven block of build.gradle)

Usage from a Gradle project

If your Gradle project depends on css4j-agent, you can use this project's own Maven repository in a repositories section of your build file:

repositories {
    maven {
        url "https://css4j.github.io/maven/"
        mavenContent {
            releasesOnly()
        }
        content {
            // Include all the groups used by popular io.sf.* projects
            includeGroupByRegex 'io\\.sf\\..*'

            // Alternatively:
            //includeGroup 'io.sf.carte'
            //includeGroup 'io.sf.jclf'
        }
    }
}

please use this repository only for the artifact groups listed in the includeGroup statements.

Then, in your build.gradle file:

dependencies {
    api "io.sf.carte:css4j-agent:${css4jAgentVersion}"
}

where css4jAgentVersion would be defined in a gradle.properties file.


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 library (and its transitive dependencies); version 5.0 or higher is recommended.

  • The xml-dtd library; version 4.1.1 or higher is recommended.

  • The validator.nu html5 parser.

  • SLF4J, which is a logging package.

Test dependencies


Website

For more information please visit https://css4j.github.io/