[json-glib/json-glib-1-2: 6/9] doc: Update the README



commit 503b813696284fec0980d5f6d464008c574e487d
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Sat Mar 18 13:20:00 2017 +0000

    doc: Update the README
    
    Replace the build instruction and dependencies to point at Meson instead
    of autotools.

 README.md |   33 ++++++++++++++++++++-------------
 1 files changed, 20 insertions(+), 13 deletions(-)
---
diff --git a/README.md b/README.md
index e01c99d..c3e1554 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ 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.
+[GNOME][gnome] project.
 
 For more information, see:
 
@@ -25,9 +25,12 @@ For more information, see:
  * [JSON-GLib][json-glib]
 
 REQUIREMENTS
-------------
+--------------------------------------------------------------------------------
 In order to build JSON-GLib you will need:
 
+ * python3
+ * [ninja](http://ninja-build.org)
+ * [meson](http://mesonbuild.com)
  * pkg-config
  * gtk-doc ≥ 1.13
  * GLib, GIO ≥ 2.38
@@ -38,15 +41,18 @@ Optionally, JSON-GLib depends on:
  * LCov ≥ 1.6
 
 INSTALLATION
-------------
+--------------------------------------------------------------------------------
 To build JSON-GLib just run:
 
-    $ ./configure
-    $ make all
-    # make install
+```sh
+  $ mkdir _build && meson _build .
+  $ ninja -C _build
+  $ ninja -C _build test
+  # ninja -C _build install
+```
 
 BUGS
-----
+--------------------------------------------------------------------------------
 JSON-GLib tracks bugs in the GNOME Bugzilla.
 
 If you find a bug in JSON-GLib, please file an issue using
@@ -64,7 +70,7 @@ Required information:
    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
@@ -74,7 +80,7 @@ RELEASE NOTES
    in case the serialization code wants to fall back to that.
 
 HACKING
--------
+--------------------------------------------------------------------------------
 JSON-GLib is developed mainly inside a GIT repository available at:
 
     https://git.gnome.org/browse/json-glib
@@ -101,7 +107,7 @@ should come with a test unit. Patches that regress the test suite will be
 rejected.
 
 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,
@@ -109,13 +115,14 @@ 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, 2011, 2012  Intel Corp.
-Copyright (C) 2013  Emmanuele Bassi
+Copyright 2007, 2008  OpenedHand Ltd
+Copyright 2009, 2010, 2011, 2012  Intel Corp.
+Copyright 2013  Emmanuele Bassi
 
 [json]: http://www.json.org "JSON"
 [glib]: http://www.gtk.org "GTK+"
 [json-glib]: https://wiki.gnome.org/Projects/JsonGlib "JSON-GLib wiki"
+[gnome]: https://www.gnome.org "GNOME"
 [bugzilla]: https://bugzilla.gnome.org "GNOME Bugzilla"
 [bugzilla-bug-page]: https://http://bugzilla.gnome.org/browse.cgi?product=json-glib "GNOME Bugzilla - 
Browse: json-glib"
 [bugzilla-enter-bug]: https://bugzilla.gnome.org/enter_bug.cgi?product=json-glib "GNOME Bugzilla - Enter 
bug: json-glib"


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