Repository :
http://git.fedorahosted.org/cgit/cura-tools.git
On branch : master
---------------------------------------------------------------
commit 2065ff89f2911de55c3622e997ffa88d0d7b70a7
Author: Michal Minar <miminar(a)redhat.com>
Date: Fri Jan 3 11:10:58 2014 +0100
updated AUTHORS and README
Rewritten README for markdown markup.
This is one patch in a series merging lmi meta-command into
openlmi-tools from original upstream on github.
Related to trac ticket #187
---------------------------------------------------------------
AUTHORS | 1 +
README | 38 ------------------------------------
README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 64 insertions(+), 38 deletions(-)
diff --git a/AUTHORS b/AUTHORS
index 8b0183a..49a7539 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,2 +1,3 @@
Author(s):
Peter Hatina <phatina(a)redhat.com>
+ Michal Minar <miminar(a)redhat.com>
diff --git a/README b/README
deleted file mode 100644
index 4c879b7..0000000
--- a/README
+++ /dev/null
@@ -1,38 +0,0 @@
-*******************************************************************************
-* OpenLMI *
-*******************************************************************************
-
-The OpenLMI project provides a common infrastructure for the management of Linux
-systems. Capabilities include configuration, management and monitoring of
-hardware, operating systems, and system services. OpenLMI includes a set of
-services that can be accessed both locally and remotely, multiple language
-bindings, standard APIs, and standard scripting interfaces.
-
-
-*******************************************************************************
-* OpenLMI-tools *
-*******************************************************************************
-
-OpenLMI-tools currently contains lmishell, a (non)interactive command
-interpreter for CIM objects access.
-
-*******************************************************************************
-* Dependencies *
-*******************************************************************************
-
-OpenLMI tools require python2.7, python setuptools and pywbem module installed.
-
-*******************************************************************************
-* Installation *
-*******************************************************************************
-
-Following steps will install the OpenLMI tools into desired directory.
-
-$ cd cli-tools
-# python setup.py install --root=/path/to/install/directory
-
-*******************************************************************************
-* Example usage *
-*******************************************************************************
-
-See man/lmishell.1 manual page.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ed0b84
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+OpenLMI
+=======
+
+The OpenLMI project provides a common infrastructure for the management of Linux
+systems. Capabilities include configuration, management and monitoring of
+hardware, operating systems, and system services. OpenLMI includes a set of
+services that can be accessed both locally and remotely, multiple language
+bindings, standard APIs, and standard scripting interfaces.
+
+OpenLMI-tools
+=============
+
+OpenLMI-tools currently contains LMIShell, a (non)interactive command
+interpreter for CIM objects access. And lmi meta-command serving as a command
+line interface to OpenLMI Providers, which utilizes LMIShell.
+
+Dependencies
+------------
+
+OpenLMI tools require
+
+ * python2.7,
+ * python-setuptools
+ * pywbem
+ * python-docopt
+
+### Uploading to PyPI
+
+Since *PyPI* expects README file to be in a *reStructuredText* markup
+language and the one present is written in *markdown*, it needs to be
+converted to it. So please make sure you have `pandoc` installed before
+running:
+
+ $ python setup.py sdist upload
+
+Installation
+------------
+
+Use standard `setuptools` script for installation:
+
+ $ cd cli
+ $ python setup.py install --root=/path/to/install/directory
+
+If you have limited access to system path, you may wish to install to user
+directory instead:
+
+ $ python setup.py install --user
+
+This installs just the *LMIShell*, *lmi meta-command* and client-side libraries.
+To install *lmi* subcommands, please refer to [git][].
+
+Example usage
+-------------
+
+See `man/lmishell.1` manual page or `man/lmi.1`
+
+Or visit our documentation on [pythonhosted][].
+
+-----------------------------------------------------------------------------
+[git]:
https://github.com/openlmi/openlmi-scripts
"openlmi-scripts"
+[providers-git]:
https://fedorahosted.org/openlmi/browser/openlmi-providers
"openlmi-providers"
+[pythonhosted]:
http://pythonhosted.org/openlmi-tools/index.html "python
hosted"
+[PyPI]:
https://pypi.python.org/pypi/openlmi-tools
"PyPI"