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

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



From: "Zeeshan Ali (Khattak)" <zeeshanak 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
-- 
1.7.6.4


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