Development

This part of the documentation is for developers working on Erbsland Core itself. It covers preparing a checkout, building and testing library changes, and using or extending the repository’s maintenance tools.

If you want to use Erbsland Core in your own application, start with Getting Started or Usage instead.

For most library work, Set Up the Repository is all you need to get started. It prepares the build environment and installs the maintenance tool so you can run it when needed. Developing that tool is a separate, optional step described in Build and Test the Maintenance Tool.

• Set Up the Repository
  • Before You Start
  • Prepare the Checkout
  • Build and Test the Library
  • Use the Maintenance Tool
  • Build the Documentation
  • Before Committing
• Use the Maintenance Tool
  • Run and Configure Commands
  • Check the Repository for Commit
  • Build the Documentation
  • Validate API Guidelines
  • Validate API Test Status
  • Update Reference Documentation
  • Prepare Doxygen Sources
  • Create a Documentation Demo
  • Process RST Documentation
  • Format ELCL Files
  • Clean Up the Code
  • Check Anti-Patterns
  • Generate Display Texts
  • Generate IDNA Data
  • Generate Unicode Data
  • Generate Category Test Data
  • Generate Time-Zone Data
  • Generate Common Box-Frame Style
  • Generate Frame-Border Joint Characters
  • Generate Public Suffix List Data
  • Customize Generated Notices
  • Update Unicode Sources
  • Update the Public Suffix List
  • Update Public Headers
  • Generate Saturating Math Data
  • Generate Time Tests
  • Import Cryptology Vectors
  • Maintain Security Hashes
  • Audit GitHub Workflow Actions
  • Inspect Include Dependencies
• Develop the Maintenance Tool
  • Build and Test the Maintenance Tool
  • Maintenance Framework Overview
  • Write a New Command
  • Shared Data Sources
  • Write a New Data Source
• Maintenance Tool Reference
  • Framework Reference
  • Pre-commit Reference
  • Rendering Configuration
  • Documentation Build Reference
  • Documentation Maintenance Reference
  • Code Cleanup Reference
  • Anti-Patterns Reference
  • Display Text Generator Reference
  • IDNA Generator Reference
  • Unicode Data Generator Reference
  • Category Test Generator Reference
  • Time-Zone Generator Reference
  • Terminal Frame Generator Reference
  • Public Suffix Generator Reference
  • Public Headers Reference
  • Saturating Math Generator Reference
  • Time Test Generator Reference
  • Cryptology Vector Importer Reference
  • Security Hashes Reference
  • GitHub Workflows Reference
  • Include Dependencies Reference