README.md

   1 JSON-GLib
   2 ===============================================================================
   3
   4 JSON-GLib implements a full suite of JSON-related tools 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 integrates with GObject to
   8 provide the ability to serialize and deserialize GObject instances to and from
   9 JSON data types.
  10
  11 JSON is the JavaScript Object Notation; it can be used to represent objects and
  12 object hierarchies while retaining human-readability.
  13
  14 GLib is a C library providing common and efficient data types for the C
  15 developers.
  16
  17 GObject is a library providing a run-time Object Oriented type system for C
  18 developers. GLib and GObject are extensively used by the GTK+ toolkit and by the
  19 GNOME project.
  20
  21 For more information, see:
  22
  23  * [JSON][json]
  24  * [GLib and GObject][glib]
  25  * [JSON-GLib][json-glib]
  26
  27 REQUIREMENTS
  28 ------------
  29 In order to build JSON-GLib you will need:
  30
  31  * pkg-config
  32  * gtk-doc ≥ 1.13
  33  * GLib, GIO ≥ 2.38
  34
  35 Optionally, JSON-GLib depends on:
  36
  37  * GObject-Introspection ≥ 1.38
  38  * LCov ≥ 1.6
  39
  40 INSTALLATION
  41 ------------
  42 To build JSON-GLib just run:
  43
  44     $ ./configure
  45     $ make all
  46     # make install
  47
  48 BUGS
  49 ----
  50 JSON-GLib tracks bugs in the GNOME Bugzilla.
  51
  52 If you find a bug in JSON-GLib, please file an issue using
  53 [the appropriate form][bugzilla-enter-bug]. You can also check
  54 [the list of open bugs][bugzilla-bug-page].
  55
  56 Required information:
  57
  58  * the version of JSON-GLib
  59   * if it is a development version, the branch of the git repository
  60  * the JSON data that produced the bug (if any)
  61  * a small, self-contained test case, if none of the test units exhibit the
  62    buggy behaviour
  63  * in case of a segmentation fault, a full stack trace with debugging
  64    symbols obtained through gdb is greatly appreaciated
  65
  66 RELEASE NOTES
  67 -------------
  68  * Prior to JSON-GLib 0.10, a JsonSerializable implementation could
  69    automatically fall back to the default serialization code by simply
  70    returning NULL from an overridden JsonSerializable::serialize-property
  71    virtual function. Since JSON-GLib 0.10 this is not possible any more. A
  72    JsonSerializable is always expected to serialize and deserialize all
  73    properties. JSON-GLib provides public API for the default implementation
  74    in case the serialization code wants to fall back to that.
  75
  76 HACKING
  77 -------
  78 JSON-GLib is developed mainly inside a GIT repository available at:
  79
  80     https://git.gnome.org/browse/json-glib
  81
  82 You can clone the GIT repository with:
  83
  84     git clone git://git.gnome.org/json-glib
  85
  86 If you want to contribute functionality or bug fixes to JSON-GLib you can either
  87 notify me to pull from your Git repository, or you can attach patches for review
  88 to a bug on [the bug tracking system][bugzilla] using
  89
  90     git format-patch master -k -s
  91
  92 to generate the patches from each commit. Using [git-bz][git-bz] to automate
  93 this process is strongly encouraged.
  94
  95 Please, try to conform to the coding style used by JSON-GLib, which is the same
  96 used by projects like GLib, GTK+, and Clutter. Coding style conformance is a
  97 requirement for upstream acceptance.
  98
  99 Make sure you always run the test suite when you are fixing bugs. New features
 100 should come with a test unit. Patches that regress the test suite will be
 101 rejected.
 102
 103 AUTHOR, COPYRIGHT AND LICENSING
 104 -------------------------------
 105 JSON-GLib has been written by Emmanuele Bassi
 106
 107 JSON-GLib is released under the terms of the GNU Lesser General Public License,
 108 either version 2.1 or (at your option) any later version.
 109
 110 See the file COPYING for details.
 111
 112 Copyright (C) 2007, 2008  OpenedHand Ltd
 113 Copyright (C) 2009, 2010, 2011, 2012  Intel Corp.
 114 Copyright (C) 2013  Emmanuele Bassi
 115
 116 [json]: http://www.json.org "JSON"
 117 [glib]: http://www.gtk.org "GTK+"
 118 [json-glib]: https://wiki.gnome.org/Project/JsonGlib "JSON-GLib wiki"
 119 [bugzilla]: https://bugzilla.gnome.org "GNOME Bugzilla"
 120 [bugzilla-bug-page]: https://http://bugzilla.gnome.org/browse.cgi?product=json-glib "GNOME Bugzilla - Browse: json-glib"
 121 [bugzilla-enter-bug]: https://bugzilla.gnome.org/enter_bug.cgi?product=json-glib "GNOME Bugzilla - Enter bug: json-glib"
 122 [git-bz]: http://blog.fishsoup.net/2008/11/16/git-bz-bugzilla-subcommand-for-git/