@chaoshilfe/taktische-zeichen/README.md

React components for the German BOS tactical signs

# taktische-zeichen
## React components for the German BOS tactical signs.

This project/package provides React components to embed tactical signs used in German "Behörden und Organisationen mit Sicherheitsaufgaben" (BOS).  
The source for the SVG files is [this upstream repository by Jonas Koeritz](https://github.com/jonas-koeritz/Taktische-Zeichen).

The license for this project is the same as the [upstream code license](https://github.com/jonas-koeritz/Taktische-Zeichen/blob/master/LICENSE) which at the time of writing this is [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/deed.en).  
Also as defined by the upstream project, the generated SVG sources are licensed under [CC-0-1.0](https://creativecommons.org/publicdomain/zero/1.0/).

## Changes to the original SVG sources

- Removed all vendor-specific SVG tags. (Because they are not supported by neither Browsers nor SVGO.)
- Optimized SVG files using SVGO (see [``src/scripts/extractSymbols.ts``](./src/scripts/extractSymbols.ts))

## How to generate sources

- Node.js 22.14
- Clone this repository
- Run ``pnpm install`` to install dependencies
- Clone the upstream repository to ``../taktische-zeichen-svg``
  - Follow dependency instructions of the upstream repository (only what is required for SVG file generation)
  - run ``make svg`` inside the upstream clone
- After the SVG files have been generated, run ``pnpm run optimize`` inside your clone of this repository
- When the SVG files have been optimized and transformed, run ``pnpm run index`` inside your clone of this repository to update the React index file.