From 2034a2140dc0908476ee83a9825c0dbad7d9a32a Mon Sep 17 00:00:00 2001
From: Radek Novacek <rnovacek@redhat.com>
Date: Mon, 30 Jul 2012 12:14:30 +0200
Subject: Merge READMEs to one, get rid of should-be-global files in service

---
 README | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 85 insertions(+), 1 deletion(-)

(limited to 'README')

diff --git a/README b/README
index 5f0dcb4..3d474d3 100644
--- a/README
+++ b/README
@@ -1,2 +1,86 @@
-Cura
+*******************************************************************************
+* Cura                                                                        *
+*******************************************************************************
+
+The Cura project provides a common infrastructure for the management of Linux
+systems. Capabilities include configuration, management and monitoring of
+hardware, operating systems, and system services. Cura includes a set of
+services that can be accessed both locally and remotely, multiple language
+bindings, standard APIs, and standard scripting interfaces. 
+
+
+*******************************************************************************
+* Cura-providers                                                              *
+*******************************************************************************
+
+cura-providers is set of (usually) small providers (agents) that will provide
+given functionality on host system.
+
+Following providers are part of this sub-project:
+
+* Fan
+    Fan provider implements interface for hardware monitoring of fans
+    in the system. It uses lm_sensors library so it's linux specific.
+
+    There are three interfaces provided according to CIM model:
+        * Linux_Fan
+            - Provides instance for every fan founded by lm_sensors with basic
+              information.
+        * Linux_FanSensor
+            - Associated sensor for each instance of Linux_Fan.
+            - Value of fan speed can be obtained from property CurrentReading.
+        * Linux_FanAssociatedSensor
+            - Provides association of instances of above 2 providers.
+
+* Power
+    Power management provider allows to monitor and change power state of the
+    computer system.
+
+    Support commands:
+        - halt, reboot, suspend, hibernate
+
+* Service
+    Provider that allows manipulation with system services.
+
+    Supported commands:
+        - status
+        - start, stop, restart
+        - enable, disable
+
+
+*******************************************************************************
+* Build Dependencies                                                          *
+*******************************************************************************
+For all providers:
+    - konkretcmpi-devel
+    - sblim-cmpi-devel
+
+Provider specific dependencies:
+* Fan
+    - lm_sensors - installed and configured
+    - lm_sensors-libs
+    - lm_sensors-devel
+* Power
+    - glib2-devel
+    - upower-devel or pm-utils
+    - shutdown and reboot commands in $PATH (usually provided by
+      systemd or upstart or SysVinit)
+* Service
+    - chkconfig
+    - systemd or upstart or SysVinit
+
+
+*******************************************************************************
+* Installation                                                                *
+*******************************************************************************
+
+$ mkdir build && cd build
+$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
+$ make
+# make install
+# make register-Fan
+# make register-PowerManagement
+# make register-Service
+
+You can disable specific provider by adding -DWITH-<PROVIDER>=0 to cmake line.
 
-- 
cgit