README

   1 JSON-GLib - A JSON parser for GLib-based libraries and applications
   2 ===============================================================================
   3
   4 JSON-GLib implements a full JSON parser using GLib and GObject.
   5
   6 Use JSON-GLib it is possible to parse and generate valid JSON data
   7 structures, using a DOM-like API. JSON-GLib also offers GObject
   8 integration, providing the ability to serialize and deserialize
   9 GObject instances to and from JSON data types.
  10
  11 JSON is the JavaScript Object Notation; it can be used to represent
  12 objects and object hierarchies while retaining human-readability.
  13
  14 GLib is a C library providing common and efficient data types for
  15 the C developers.
  16
  17 GObject is a library providing a run-time Object Oriented type system
  18 for C developers. GLib and GObject are extensively used by the GTK+
  19 toolkit and by the GNOME project.
  20
  21 For more information, see:
  22   • JSON: http://www.json.org
  23   • GLib and GObject: http://www.gtk.org
  24
  25 REQUIREMENTS
  26 ------------
  27 In order to build JSON-GLib you will need:
  28
  29   • pkg-config
  30   • gtk-doc ≥ 1.13
  31   • GLib, GIO ≥ 2.26
  32
  33 Optionally, JSON-GLib depends on:
  34
  35   • GObject-Introspection ≥ 0.9.5
  36
  37 INSTALLATION
  38 -------------------------------------------------------------------------------
  39 To build JSON-GLib just run:
  40
  41   $ ./configure
  42   $ make all
  43   # make install
  44
  45 BUGS
  46 -------------------------------------------------------------------------------
  47 If you find a bug in JSON-GLib, please create a Bugzilla entry here:
  48
  49   http://bugzilla.gnome.org/enter_bug.cgi?product=json-glib
  50
  51 Attaching:
  52
  53   • the version of JSON-GLib
  54     ◦ if it is a development version, the branch of the git repository
  55   • the JSON data that produced the bug (if any)
  56   • a small test case, if none of the test units exhibit the behaviour
  57   • in case of a segmentation fault, a full stack trace with debugging
  58     symbols obtained through gdb is greatly appreaciated
  59
  60 RELEASE NOTES
  61 -------------------------------------------------------------------------------
  62 • Prior to JSON-GLib 0.10, a JsonSerializable implementation could
  63   automatically fall back to the default serialization code by simply
  64   returning NULL from an overridden JsonSerializable::serialize_property()
  65   virtual function. Since JSON-GLib 0.10 this is not possible any more. A
  66   JsonSerializable is always expected to serialize and deserialize all
  67   properties. JSON-GLib provides public API for the default implementation
  68   in case the serialization code wants to fall back to that.
  69
  70 HACKING
  71 -------------------------------------------------------------------------------
  72 JSON-GLib is developed mainly inside a GIT repository available at:
  73
  74   http://git.gnome.org/browse/json-glib
  75
  76 You can clone the GIT repository with:
  77
  78   git clone git://git.gnome.org/json-glib
  79
  80 If you want to contribute functionality or bug fixes to JSON-GLib you
  81 can either notify me to pull from your GIT repository or send me a set
  82 of patches using:
  83
  84   git format-patch master -k -s
  85
  86 or:
  87
  88   git send-email -k -s
  89
  90 Make sure you always run the test suite when you are fixing bugs. New
  91 features should come with a test unit.
  92
  93 AUTHOR, COPYRIGHT AND LICENSING
  94 -------------------------------------------------------------------------------
  95 JSON-GLib has been written by Emmanuele Bassi
  96
  97 JSON-GLib is released under the terms of the GNU Lesser General Public License,
  98 either version 2.1 or (at your option) any later version.
  99
 100 See the file COPYING for details.
 101
 102 Copyright (C) 2007, 2008  OpenedHand Ltd
 103 Copyright (C) 2009, 2010  Intel Corp.