diff options
author | Richard Hughes <richard@hughsie.com> | 2014-03-17 20:46:04 +0000 |
---|---|---|
committer | Richard Hughes <richard@hughsie.com> | 2014-03-17 20:46:04 +0000 |
commit | 3a3d602269cad59dcb9f73dfe2d2dc24de29d85b (patch) | |
tree | 8a8f48246aa62f15d161ea6014ce63e0cca9f321 | |
parent | 18111df9cd7dd2ec2bfe71e657bd1c810293289d (diff) | |
download | appstream-glib-3a3d602269cad59dcb9f73dfe2d2dc24de29d85b.tar.gz |
trivial: Update README to reflect reality
-rw-r--r-- | Makefile.am | 2 | ||||
-rw-r--r-- | README | 4 | ||||
-rw-r--r-- | README.md | 56 | ||||
-rw-r--r-- | configure.ac | 44 | ||||
-rw-r--r-- | contrib/libappstream-glib.spec.in | 8 |
5 files changed, 79 insertions, 35 deletions
diff --git a/Makefile.am b/Makefile.am index f655be6..f12450b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -31,7 +31,7 @@ EXTRA_DIST = \ MAINTAINERS \ AUTHORS \ INSTALL \ - README \ + README.md \ NEWS \ autogen.sh \ config.h @@ -1,4 +0,0 @@ -AppStream-Glib - -This library provides objects and helper methods to help reading and writing -AppStream metadata. It does not actually parse data to and from XML format. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a1944d9 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +AppStream-Glib +============== + +This library provides GObjects and helper methods to make it easy to read and +write AppStream metadata. It also provides a simple DOM implementation that +makes it easy to edit nodes and convert to and from the standardized XML +representation. + +What this library allows you to do: + + * Read and write compressed AppStream XML files + * Add and search for applications in an application store + * Get screenshot image data and release announcements + * Easily retrieve the best application data for the current locale + * Efficiently interface with more heavy-weight parsers like expat + +For more information about what AppStream is, please see the wikie here: +http://www.freedesktop.org/wiki/Distributions/AppStream/ + +Getting Started +--------------- + +To install the libappstream-glib library you either need to install the +`libappstream-glib` package from your distributor, or you can build a local +copy. To do the latter just do: + + dnf install automake autoconf libtool glib-devel + ./autogen.sh + make + make install + +More Information +---------------- + +If you want to actually generate metadata rather than just consuming it, you +probably want to be looking at: https://github.com/hughsie/createrepo_as or if +you're completely lost, GNOME Software is a GUI tool that uses this library to +implement a software center. See `src/plugins/gs-plugin-appstream.c` if you +want some more examples on using this library where speed and latency really +matter. + +Hacking +------- + +If you want a new feature, or have found a bug or a way to crash this library, +please report as much information as you can to the issue tracker: +https://github.com/hughsie/appstream-glib/issues -- patches very welcome. + +New functionality or crash fixes should include a test in `src/as-self-test.c` +to ensure we don't regress in the future. New functionality should also be +thread safe and also not leak *any* memory for success or failure cases. + +License +---- + +LGPLv2+ diff --git a/configure.ac b/configure.ac index ad71bd6..1ea7b49 100644 --- a/configure.ac +++ b/configure.ac @@ -6,9 +6,9 @@ m4_define([as_micro_version], [0]) m4_define([as_version], [as_major_version.as_minor_version.as_micro_version]) -AC_INIT([appstream-glib],[0.1.0]) +AC_INIT([appstream-glib],[as_version]) AC_CONFIG_SRCDIR(libappstream-glib) -AM_INIT_AUTOMAKE([1.9 no-dist-gzip dist-xz tar-ustar]) +AM_INIT_AUTOMAKE([1.9 no-dist-gzip dist-xz tar-ustar foreign]) AC_CONFIG_HEADERS([config.h]) AC_CONFIG_MACRO_DIR([m4]) AC_SYS_LARGEFILE @@ -27,15 +27,23 @@ AC_SUBST(AS_VERSION) # enable nice build output on automake1.11 m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])]) -# libtool versioning - this applies to libappstream_glib +# libtool versioning - this applies to libpackagekit # # See http://sources.redhat.com/autobook/autobook/autobook_91.html#SEC91 for details # -# increment; -# CURRENT If the API or ABI interface has changed (reset REVISION to 0) -# REVISION If the API and ABI remains the same, but bugs are fixed. -# AGE If libappstream_glib can be linked into executables which can be -# built with previous versions of this library. Don't use. +# - If interfaces have been changed or added, but binary compatibility +# has been preserved, change: +# CURRENT += 1 +# REVISION = 0 +# AGE += 1 +# - If binary compatibility has been broken (eg removed or changed +# interfaces), change: +# CURRENT += 1 +# REVISION = 0 +# AGE = 0 +# - If the interface is the same as the previous version, but bugs are +# fixed, change: +# REVISION += 1 LT_CURRENT=1 LT_REVISION=0 LT_AGE=0 @@ -81,14 +89,9 @@ fi AC_SUBST(WARNINGFLAGS_C) dnl --------------------------------------------------------------------------- -dnl - Library dependencies -dnl --------------------------------------------------------------------------- -GLIB_REQUIRED=2.14.0 - -dnl --------------------------------------------------------------------------- dnl - Check library dependencies dnl --------------------------------------------------------------------------- -PKG_CHECK_MODULES(GLIB, glib-2.0 >= $GLIB_REQUIRED gio-2.0 gobject-2.0 gthread-2.0) +PKG_CHECK_MODULES(GLIB, glib-2.0 >= 2.14.0 gio-2.0 gobject-2.0 gthread-2.0) dnl --------------------------------------------------------------------------- dnl - Makefiles, etc. @@ -103,16 +106,3 @@ docs/api/Makefile docs/api/version.xml ]) AC_OUTPUT - -dnl ========================================================================== -echo " - AppStream-Glib $VERSION - ======================== - - prefix: ${prefix} - datadir: ${datadir} - compiler: ${CC} - cflags: ${CFLAGS} - cppflags: ${CPPFLAGS} -" - diff --git a/contrib/libappstream-glib.spec.in b/contrib/libappstream-glib.spec.in index 5bfdb67..a791026 100644 --- a/contrib/libappstream-glib.spec.in +++ b/contrib/libappstream-glib.spec.in @@ -15,8 +15,10 @@ BuildRequires: gtk-doc BuildRequires: gobject-introspection-devel %description -This library provides objects and helper methods to help reading and writing -AppStream metadata. It does not actually parse data to and from XML format. +This library provides GObjects and helper methods to make it easy to read and +write AppStream metadata. It also provides a simple DOM implementation that +makes it easy to edit nodes and convert to and from the standardized XML +representation. %package devel Summary: GLib Libraries and headers for appstream-glib @@ -48,7 +50,7 @@ rm -f $RPM_BUILD_ROOT%{_libdir}/libappstream-glib*.la %files %defattr(-,root,root,-) -%doc README AUTHORS NEWS COPYING +%doc README.md AUTHORS NEWS COPYING %{_libdir}/*libappstream-glib*.so.* %{_libdir}/girepository-1.0/*.typelib |