xref: /openbmc/libcper/README.md (revision 079d581e)
1# CPER JSON Representation & Conversion Library
2This repository specifies a structure for representing UEFI CPER records (as described in UEFI Specification Appendix N) in a human-readable JSON format, in addition to a library which can readily convert back and forth between the standard CPER binary format and the specified structured JSON.
3
4## Building
5This project uses CMake (>=3.10). To build, simply run:
6```
7cmake .
8make
9```
10A static library file for the parsing library will be written to `lib/`, and test executables will be written to `bin/`.
11
12## Specification
13The specification for this project can be found in `specification/`.
14Specification for the CPER binary format can be found in [UEFI Specification Appendix N](https://uefi.org/sites/default/files/resources/UEFI_Spec_2_9_2021_03_18.pdf) (2021/03/18).