---
git_hash: "943a2a54d98ae07542919b05107b1c45ff47681e"
modified: "2026-08-21"
---

# Project Documentation

Developer-focused documentation for the [@ogis/icons](../README.md) codebase — an open GIS icon set shipped as an SVG sprite, icon font, and CSS/SCSS classes.

## Reading Order

1. [Build pipeline & icon import](1.build.md) — how `dist/` is generated from `src/`, and how to add icons from npm packages

## Quick Links

- [Main README](../README.md)
- [Source: src/svg/](../src/svg/)
- [Build script: scripts/build.js](../scripts/build.js)
- [Import script: scripts/import-icons.js](../scripts/import-icons.js)

## Documentation Coverage

This documentation covers:

- The build pipeline (PNG tracing, normalisation, sprite, font, codepoints, SCSS variables)
- The icon import workflow from npm icon packages

For API references and inline documentation, see source code comments.