hexatomic: A Java repository from bbunzeck

Hexatomic

A platform for deep multi-layer linguistic corpus annotation.
Read the user docs » | Read the developer/maintainer docs »

Report Bug · Request Feature

Table of Contents
About The Project
- Technologies
Getting Started
- Prerequisites
- Build
Documentation
Roadmap
Contributing
Key documents
Changelog
License
Contact
Team

About The Project

Hexatomic is an extensible, OS-independent platform for deep multi-layer linguistic annotation of corpora.

It is being developed for sustainability, in order to support research software re-use rather than new development of software with each new research project. Using Hexatomic, linguistic research projects can implement what they need on top of an existing platform with high compatibility to other tools and pipelines.

Hexatomic is funded by Deutsche Forschungsgemeinschaft (DFG) under grant number 391160252.

Development is based at the Department of English Studies (Friedrich Schiller University Jena) and the Department for German Studies and Linguistics (Humboldt-Universität zu Berlin).

Technologies

Hexatomic is a Java application based on the Eclipse 4 Platform.
The Hexatomic documentation is built with mdbook, a utility to create modern online books from Markdown files.

Getting Started

Clone this repository to your computer:

git clone https://github.com/hexatomic/hexatomic.git

Prerequisites

You need at least the following software installed on your computer to develop Hexatomic:

Java Development Kit (JDK) version >= 1.8, either OpenJDK (Linux, Mac OS), or Oracle JDK (Windows)
Apache Maven version >= 3.6.0

If you want to build the documentation locally, you also need

mdbook version >= 0.3.1

For development, we recommend that you use the tooling provided by the

Eclipse IDE version >= 2019-06

Build

Go to the repository root on your computer, and run the following command to verify that the project builds.

mvn clean install

Documentation

Please refer to the documentation for details on how to develop Hexatomic: Developer & Maintainer Documentation.

If you are looking for documentation of how to use Hexatomic, please refer to the user documentation.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

We welcome contributions from the community!

Please refer to the CONTRIBUTING.md file for information on how to contribute to Hexatomic.

If you contribute to Hexatomic in any way, you are expected to adhere to our project's Code of Conduct.

Key documents

Contributing to Hexatomic - How to contribute to the development of this module.
Code of Conduct - The code of conduct that we expect contributors to adhere to.
Developer documentation - Important documentation on development and tools.

Changelog

See CHANGELOG.md.

License

The Hexatomic software is licensed under the Apache License, Version 2.0. See LICENSE for more information.
The Hexatomic documentation is licensed under a CC0 1.0 Universal (CC0 1.0) license.