Skip to content

brailleapps/dotify.api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

162c272 · Aug 31, 2019
Aug 31, 2019
May 24, 2019
Apr 29, 2019
Mar 30, 2016
Jan 2, 2018
Jan 16, 2019
Jul 31, 2019
Jul 6, 2018
Jul 6, 2018
May 8, 2019
May 24, 2019
Aug 31, 2019
Aug 31, 2019
Aug 31, 2016
Dec 4, 2018
Jun 1, 2016
Mar 18, 2019
Mar 18, 2019

Repository files navigation

Build Status Type License: LGPL v2.1

Dotify APIs

Provides the Dotify APIs.

Using

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

To use the API, you need to download at least one implementation as well. Here's a list of known implementations:

  • dotify.formatter.impl
  • dotify.translator.impl
  • dotify.text.impl
  • dotify.hyphenator.impl
  • 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 Dotify API development is available here.

More information

See the common wiki for more information.