[mirror_edk2.git] / RedfishPkg / Library / JsonLib / Readme.rst

=============================================================================\r
                             Introduction\r
=============================================================================\r
  Jansson is a C library for encoding, decoding and manipulating JSON data.\r
Its main features and design principles are:\r
\r
  - Simple and intuitive API and data model\r
  - Comprehensive documentation\r
  - No dependencies on other libraries\r
  - Full Unicode support (UTF-8)\r
  - Extensive test suite\r
\r
  Jansson is licensed under the MIT license(refer to ReadMe.rst under edk2).\r
It is used in production and its API is stable. It works on numerous\r
platforms, including numerous Unix like systems and Windows. It's suitable\r
for use on any system, including desktop, server, and small embedded systems.\r
\r
  In UEFI/EDKII environment, Redfish project consumes jansson to achieve JSON\r
operations.\r
\r
* Jansson version on edk2: 2.13.1, API reference is on the below URL,\r
  https://jansson.readthedocs.io/en/2.13/apiref.html\r
\r
* EDKII jansson library wrapper:\r
   - JsonLib.h:\r
     This is the denifitions of EDKII JSON APIs which are mapped to\r
     jannson funcitons accordingly.\r
\r
*Known issue:\r
   Build fail with jansson/src/load.c, add code in load.c to conditionally\r
   use stdin according to HAVE_UNISTD_H macro. The PR is submitted to\r
   jansson open source community.\r
   https://github.com/akheron/jansson/pull/558\r
\r
\r
Commit	Line	Data
ea830b96 AC	1	=============================================================================\r
	2	Introduction\r
	3	=============================================================================\r
	4	Jansson is a C library for encoding, decoding and manipulating JSON data.\r
	5	Its main features and design principles are:\r
	6	\r
	7	- Simple and intuitive API and data model\r
	8	- Comprehensive documentation\r
	9	- No dependencies on other libraries\r
	10	- Full Unicode support (UTF-8)\r
	11	- Extensive test suite\r
	12	\r
	13	Jansson is licensed under the MIT license(refer to ReadMe.rst under edk2).\r
	14	It is used in production and its API is stable. It works on numerous\r
	15	platforms, including numerous Unix like systems and Windows. It's suitable\r
	16	for use on any system, including desktop, server, and small embedded systems.\r
	17	\r
	18	In UEFI/EDKII environment, Redfish project consumes jansson to achieve JSON\r
	19	operations.\r
	20	\r
	21	* Jansson version on edk2: 2.13.1, API reference is on the below URL,\r
	22	https://jansson.readthedocs.io/en/2.13/apiref.html\r
	23	\r
	24	* EDKII jansson library wrapper:\r
	25	- JsonLib.h:\r
	26	This is the denifitions of EDKII JSON APIs which are mapped to\r
	27	jannson funcitons accordingly.\r
	28	\r
	29	*Known issue:\r
	30	Build fail with jansson/src/load.c, add code in load.c to conditionally\r
	31	use stdin according to HAVE_UNISTD_H macro. The PR is submitted to\r
	32	jansson open source community.\r
	33	https://github.com/akheron/jansson/pull/558\r
	34	\r
	35	\r