Introduction
This is documentation for developers and maintainers of Hexatomic.
If you are looking for documentation of how to use Hexatomic, please refer to the user documentation.
Contributing to Hexatomic development
Hexatomic is an open source project. We welcome contributions from the community.
If you want to contribute code to Hexatomic, please make yourself familiar with the general contributing guidelines first, then continue to read this documentation.
The contributing guidelines also include information on how to report a bug, request a feature, etc.
Requirements
Hexatomic is an Eclipse e4 application, built on the Eclipse Platform for rich client applications, and implemented in Java. It is built with Apache Maven and the Eclipse Tycho extension, and versioned with Git.
It will be easier for you to contribute to Hexatomic if you already have some experience with these technologies.
Here are links to some resources that can help you get started:
- Java 8 tutorials by Oracle
- Maven in 5 minutes - Tutorial by the Apache Software Foundation
- Eclipse RCP (Rich Client Platform) - Tutorial by Lars Vogel
- Eclipse Tycho for building plug-ins, OSGi bundles and Eclipse applications - Tutorial by Lars Vogel and Simon Scholz
- Standard Widget Toolkit (SWT) for developing user interfaces in Eclipse-based applications
- Version Control with Git - Software Carpentry lesson by Daisie Huang and Ivan Gonzalez1
License
Unless otherwise noted, this documentation is licensed under a CC0 1.0 Universal (CC0 1.0) license. Please see the section License for details.
Daisie Huang and Ivan Gonzalez (eds): "Software Carpentry: Version Control with Git." Version 2016.06, June 2016, https://github.com/swcarpentry/git-novice, doi:https://doi.org/10.5281/zenodo.57467