Clarify diff report controls and README links

Document the text limit, JSON omission counters, and hierarchy options. Use absolute links for the documentation referenced by the README.
This commit is contained in:
Jan Petykiewicz 2026-11-18 12:37:10 -08:00
commit 9d5fe27516

View file

@ -10,7 +10,7 @@ bindings and a C API.
Comparisons ignore timestamps and element order while preserving duplicates and
other object details. They compare object fields and coordinates exactly; see the
[comparison rules](docs/comparison.md) for supported normalization and limits.
[comparison rules][comparison] for supported normalization and limits.
## Try the command-line tools
@ -24,8 +24,8 @@ pheon hierarchy chip.gds --format mermaid
```
`diff` returns 0 for equality, 1 for differences, and 2 for invalid or incomplete
comparisons. Start with the [CLI guide](docs/cli.md), then set up
[Git integration](docs/git.md) if you review layouts in a repository.
comparisons. Start with the [CLI guide][cli], then set up
[Git integration][git] if you review layouts in a repository.
## Read layouts in Python
@ -45,13 +45,21 @@ print(layout.field("lib_name")[0].as_py())
```
Source installation needs Rust; prebuilt Python wheels bundle the native library.
The [Python guide](docs/python.md) covers installation, selected reads, and integer
packing. The [Arrow reference](docs/arrow-schema.md) describes the returned data.
The [Python guide][python] covers installation, selected reads, and integer
packing. The [Arrow reference][arrow] describes the returned data.
## Learn more
Browse the [documentation](docs/index.md) for layer names, native integration,
Browse the [documentation][docs] for layer names, native integration,
JSON reports, development, and releases. For writing, Pheon provides low-level
GDSII record helpers in Rust.
Licensed under [GPL-3.0-only](LICENSE.md).
Licensed under [GPL-3.0-only][license].
[arrow]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/arrow-schema.md
[cli]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/cli.md
[comparison]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/comparison.md
[docs]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/index.md
[git]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/git.md
[license]: https://mpxd.net/code/jan/pheon/src/branch/master/LICENSE.md
[python]: https://mpxd.net/code/jan/pheon/src/branch/master/docs/python.md