Difference between revisions of "Main Page"
(link to new API documentation) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | + | =Introduction= | |
| − | + | '''zzjson''' is a lightweight C library for reading, writing, querying and creating JSON objects. The basic library is character encoding agnostic, but with the proper (included) callbacks, it can support the full range of Unicode encodings. Its main objective is to be small, fast and modular. For example, if you just need to read and write (nested) arrays of numbers from and to a file, you don't need Unicode support, in which case the library can be as small as 6kB, including object file overhead. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | == | + | =Installation= |
| − | + | ||
| − | |||
| + | * You need a decent shell and userland (POSIX <tt>sh</tt> preferred) | ||
| + | * Download and unpack the latest tarball | ||
| + | * Run <tt>./buildstatic.sh</tt> or <tt>./buildshared.sh</tt> or both | ||
| + | * No errors? Run <tt>./install.sh</tt> | ||
| + | * Report errors on the <tt>zzjson-devel</tt> mailinglist | ||
| + | <tt>install.sh</tt> looks at two environment variables, namely <tt>PREFIX</tt> and <tt>DESTDIR</tt>. So if you want to install to another location instead of the default <tt>/usr/local</tt>, use something like: <tt>PREFIX=/opt ./install.sh</tt>. Packagers can use: <tt>DESTDIR=/some/dir PREFIX=/usr ./install.sh</tt>. | ||
| + | |||
| + | You can also incorporate the '''zzjson''' source code into your own project, either by using an Subversion external reference or by copying the code (be sure to send any improvements and bug fixes upstream to the <tt>zzjson-devel</tt> mailinglist). | ||
| + | |||
| + | =Documentation= | ||
| + | |||
| + | : [[API Documentation (version 1.1.x)]] | ||
| + | : [[API Documentation (version 1.0.x)]] | ||
| + | |||
| + | =Reporting bugs and/or patches= | ||
| + | |||
| + | ''Detailed'' bug reports or patches can be sent to the [https://lists.sourceforge.net/lists/listinfo/zzjson-devel zzjson-devel mailinglist]. | ||
| + | |||
| + | =Versioning= | ||
| + | |||
| + | The full version number consists of a ''major'', ''minor'' and ''micro'' number. The meaning of those are<br> | ||
| + | as follows: | ||
| + | * ''major'': major release, API/ABI changed | ||
| + | * ''minor'': minor release, API/ABI changed | ||
| + | * ''micro'': bugfixes, new features, API/ABI '''un'''changed | ||
| + | |||
| + | There is not, and never has been, such thing as version zero. | ||
| + | |||
| + | =Copyright= | ||
| + | |||
| + | '''zzjson''' was written by ''Ivo van Poorten'', Copyright (C) 2008 and licensed under the GNU Lesser General Public License, version 2.1. | ||
Latest revision as of 01:00, 16 August 2009
Contents
Introduction
zzjson is a lightweight C library for reading, writing, querying and creating JSON objects. The basic library is character encoding agnostic, but with the proper (included) callbacks, it can support the full range of Unicode encodings. Its main objective is to be small, fast and modular. For example, if you just need to read and write (nested) arrays of numbers from and to a file, you don't need Unicode support, in which case the library can be as small as 6kB, including object file overhead.
Installation
- You need a decent shell and userland (POSIX sh preferred)
- Download and unpack the latest tarball
- Run ./buildstatic.sh or ./buildshared.sh or both
- No errors? Run ./install.sh
- Report errors on the zzjson-devel mailinglist
install.sh looks at two environment variables, namely PREFIX and DESTDIR. So if you want to install to another location instead of the default /usr/local, use something like: PREFIX=/opt ./install.sh. Packagers can use: DESTDIR=/some/dir PREFIX=/usr ./install.sh.
You can also incorporate the zzjson source code into your own project, either by using an Subversion external reference or by copying the code (be sure to send any improvements and bug fixes upstream to the zzjson-devel mailinglist).
Documentation
Reporting bugs and/or patches
Detailed bug reports or patches can be sent to the zzjson-devel mailinglist.
Versioning
The full version number consists of a major, minor and micro number. The meaning of those are
as follows:
- major: major release, API/ABI changed
- minor: minor release, API/ABI changed
- micro: bugfixes, new features, API/ABI unchanged
There is not, and never has been, such thing as version zero.
Copyright
zzjson was written by Ivo van Poorten, Copyright (C) 2008 and licensed under the GNU Lesser General Public License, version 2.1.
