[virt-tools-list] [libosinfo 1/2] Improved README file

[Daniel P. Berrange]

On Fri, Oct 21, 2011 at 05:47:30PM +0300, Zeeshan Ali (Khattak) wrote:
> From: "Zeeshan Ali (Khattak)" <zeeshanak at gnome.org>
> 
> ---
>  README |   31 +++++++++++++++++++++++--------
>  1 files changed, 23 insertions(+), 8 deletions(-)
> 
> diff --git a/README b/README
> index 775a22a..c073a18 100644
> --- a/README
> +++ b/README
> @@ -1,10 +1,25 @@
> -README
> +libosinfo
> +=========
>  
> -Requirements:
> -libxml2-devel
> +libosinfo is a GObject based library API for managing information about
> +operating systems, hypervisors and the (virtual) hardware devices they can
> +support. It includes a database containing device metadata and provides APIs
> +to match/identify optimal devices for deploying an operating system on a
> +hypervisor. Via the magic of GObject Introspection, the API is available in all
> +common programming languages with demos for javascript (GJS/Seed) and python
> +(PyGObject). Also provided are Vala bindings.
> +
> +libosinfo is Free Software and licenced under LGPLv2+.
> +
> +Dependencies
> +============
> +
> +- Required:
> +  - gobject-2.0
> +  - gio-2.0
> +  - libxml-2.0
> +
> +- Optional:
> +  - gobject-introspection
> +  - Vala (build-time only)
>  
> -To build and test:
> -1. 'make lib' to build the library as bin/libosinfo.so
> -2. 'make test' to compile all the tests and place them in bin/
> -3. Change LD_LIBRARY_PATH to include the directory with libosinfo.so
> -4. Run each test in bin/. Will return 0 on successful completion.
> \ No newline at end of file
> -- 

ACK


Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|