[json-glib] docs: Use markdown in the README



commit 88e5fdd588fe3a70e1e262bc7b414e3e527e21b6
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Fri Nov 11 15:08:08 2011 +0000

    docs: Use markdown in the README

 README    |  103 --------------------------------------------------------
 README.md |  112 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+), 103 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b2ff9e3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,112 @@
+JSON-GLib - A JSON parser for GLib-based libraries and applications
+===================================================================
+
+JSON-GLib implements a full JSON parser using GLib and GObject.
+
+Use JSON-GLib it is possible to parse and generate valid JSON data
+structures, using a DOM-like API. JSON-GLib also offers GObject
+integration, providing the ability to serialize and deserialize
+GObject instances to and from JSON data types.
+
+JSON is the JavaScript Object Notation; it can be used to represent
+objects and object hierarchies while retaining human-readability.
+
+GLib is a C library providing common and efficient data types for
+the C developers.
+
+GObject is a library providing a run-time Object Oriented type system
+for C developers. GLib and GObject are extensively used by the GTK+
+toolkit and by the GNOME project.
+
+For more information, see:
+
+ * [JSON][json]
+ * [GLib and GObject][glib]
+
+REQUIREMENTS
+------------
+In order to build JSON-GLib you will need:
+
+ * pkg-config
+ * gtk-doc â 1.13
+ * GLib, GIO â 2.28
+
+Optionally, JSON-GLib depends on:
+
+ * GObject-Introspection â 0.9.5
+
+INSTALLATION
+-------------
+To build JSON-GLib just run:
+
+    $ ./configure
+    $ make all
+    # make install
+
+BUGS
+----
+JSON-GLib tracks bugs in the GNOME Bugzilla.
+
+If you find a bug in JSON-GLib, please file a bug using
+[the appropriate form][bugzilla-enter].
+
+Required information:
+
+ * the version of JSON-GLib;
+ * if it is a development version, the branch of the git repository;
+ * the JSON data that produced the bug (if any);
+ * a small test case, if none of the test units exhibit the behaviour;
+ * in case of a segmentation fault, a full stack trace with debugging
+   symbols obtained through gdb is greatly appreaciated.
+
+RELEASE NOTES
+-------------
+ * Prior to JSON-GLib 0.10, a JsonSerializable implementation could
+   automatically fall back to the default serialization code by simply
+   returning NULL from an overridden JsonSerializable::serialize-property
+   virtual function. Since JSON-GLib 0.10 this is not possible any more. A
+   JsonSerializable is always expected to serialize and deserialize all
+   properties. JSON-GLib provides public API for the default implementation
+   in case the serialization code wants to fall back to that.
+
+HACKING
+-------
+JSON-GLib is developed mainly inside a GIT repository available at:
+
+    http://git.gnome.org/browse/json-glib
+
+You can clone the GIT repository with:
+
+    git clone git://git.gnome.org/json-glib
+
+If you want to contribute functionality or bug fixes to JSON-GLib you
+can either notify me to pull from your GIT repository or send me a set
+of patches using:
+
+    git format-patch master -k -s
+
+or:
+
+    git send-email -k -s
+
+Using [git-bz][git-bz] is recommended.
+
+Make sure you always run the test suite when you are fixing bugs. New
+features should come with a test unit.
+
+AUTHOR, COPYRIGHT AND LICENSING
+-------------------------------
+JSON-GLib has been written by Emmanuele Bassi
+
+JSON-GLib is released under the terms of the GNU Lesser General Public License,
+either version 2.1 or (at your option) any later version.
+
+See the file COPYING for details.
+
+Copyright (C) 2007, 2008  OpenedHand Ltd
+Copyright (C) 2009, 2010  Intel Corp.
+
+[json]: http://www.json.org "JSON"
+[glib]: http://www.gtk.org "GTK+"
+[bug-enter]: http://bugzilla.gnome.org/enter_bug.cgi?product=json-glib "GNOME Bugzilla - Enter bug: json-glib"
+[git-bz]: http://blog.fishsoup.net/2008/11/16/git-bz-bugzilla-subcommand-for-git/



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]