Skip to content

Developer Guide

Welcome to the Developer Guide for the Tileverse Range Reader. This guide is for developers who want to contribute to the project, understand its internal architecture, or extend its functionality.

What You'll Find

This guide provides comprehensive information for project contributors and maintainers:

  • Architecture: A deep dive into the design patterns, module structure, and core principles of the library.
  • Building: Instructions on how to build the project from source, including prerequisites and build commands.
  • Testing: An overview of the testing strategy, including unit, integration, and performance tests.
  • Performance: Guidance on benchmarking, profiling, and optimizing the library.
  • Contributing: Guidelines for contributing code, documentation, and bug reports.

Prerequisites

Before you start, ensure you have the following installed:

  • Java 21+ (for development)
  • Maven 3.9+
  • Docker (for integration tests)
  • Git