Skip to content
This repository has been archived by the owner on Nov 5, 2018. It is now read-only.

ARCHIVED (see readme.md): Provides the API used in Braille Utils

License

Notifications You must be signed in to change notification settings

brailleapps/braille-utils.api

Repository files navigation

Type License: LGPL v2.1

Note: This project has been merged into dotify.api (https://github.com/brailleapps/dotify.api) and will not be updated anymore. Please use dotify.api instead.

braille-utils.api

This contains the Braille Utils API.

Using

To implement the API, download the latest release from maven central.

To use the API, you also need to download at least one implementation (for example braille-utils.impl).

Building

Build with gradlew build (Windows) or ./gradlew build (Mac/Linux)

Testing

Tests are run with gradlew test (Windows) or ./gradlew test (Mac/Linux)

Requirements & Compatibility

  • Requires Java 8
  • Implementations can be provided with SPI and/or OSGi

Javadoc

Javadoc for the latest Braille Utils API development is available here.

More information

See the common wiki for more information.