# Readme for the package hexdumptikz

Author: Lukas Heindl (`oss.heindl+latex@protonmail.com`).

<!-- CTAN page: [hexdumptikz](https://ctan.org/pkg/hexdumptikz) -->

## License
The LaTeX package `hexdumptikz` is distributed under the LPPL 1.3c license.

## Description
The package provides an environment `hexdumptikz` which can be used to show a [hexdump](https://en.wikipedia.org/wiki/Hex_dump) with Ti*k*Z.
Every byte is shown with its own node.
This way one can annotate the hexdump freely.

The package explicitly also works when the hexdump contains large offsets as it tries to avoid calculations directly on the addresses and if required only calculates on the last digits of the addresses.

For a more detailled documentation, have a look at the `hexdumptikz.pdf` file generated e.g. with `l3build doc`.

## Installation

For a manual installation:

* put the files `hexdumptikz.ins` and `*.dtx` in the
same directory;
* run `latex hexdumptikz.ins` in that directory.

The files `hexdumptikz*.sty` will be generated.

### Simplified version

* run `l3build unpack` to generate the `.sty`s in `build/unpacked/`