Nir Soffer has uploaded a new change for review.
Change subject: readme: Covert to markdown format ......................................................................
readme: Covert to markdown format
Markdown is nicer to work with and render nicer in github.
Change-Id: I74ce4bcb8bb276e98fc6466ace7709733dd809c1 Signed-off-by: Nir Soffer nsoffer@redhat.com --- M Makefile.am R README.md M vdsm.spec.in 3 files changed, 26 insertions(+), 25 deletions(-)
git pull ssh://gerrit.ovirt.org:29418/vdsm refs/changes/60/65260/1
diff --git a/Makefile.am b/Makefile.am index 64cd9a0..789221c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -19,6 +19,9 @@ # TOX_MIN_VERSION = 2.1.1
+# We don't want the standard gnu file setup (README, INSTALL, etc.) +AUTOMAKE_OPTIONS = foreign + SUBDIRS = \ client \ contrib \ @@ -42,6 +45,7 @@ EXTRA_DIST = \ .gitignore \ README.logging \ + README.md \ autobuild.sh \ autogen.sh \ build-aux/pkg-version \ diff --git a/README b/README.md similarity index 68% rename from README rename to README.md index 955dfa9..9398827 100644 --- a/README +++ b/README.md @@ -1,5 +1,4 @@ - Vdsm: Virtual Desktop Server Manager - ==================================== +# Vdsm: Virtual Desktop Server Manager
The Vdsm service exposes an API for managing virtualization hosts running the KVM hypervisor technology. Vdsm manages and monitors @@ -7,53 +6,53 @@ creation, other host administration tasks, statistics gathering, and log collection.
-Installation -============ + +## Installation
The Vdsm service can be used by following the standard autotools installation process, documented in the INSTALL file. As a quick start you can do
- ./configure --prefix=/usr --sysconfdir=/etc \ + ./configure --prefix=/usr --sysconfdir=/etc \ --localstatedir=/var --libdir=/usr/lib - make - sudo make install + make + sudo make install
In order to start vdsm at first try, please perform:
- vdsm-tool configure [--force] + vdsm-tool configure [--force]
- * --force flag will override old conf files with vdsm defaults and restart - services that were configured (if were already running) +--force flag will override old conf files with vdsm defaults and restart +services that were configured (if were already running)
-Packaging -========= + +## Packaging
The 'vdsm.spec' file demonstrates how to distribute Vdsm as an RPM package.
-Getting Help -============ + +## Getting Help
There are two mailing lists for discussions:
- - For technical discussions about the project and its code base. +- For technical discussions about the project and its code base.
- http://lists.ovirt.org/mailman/listinfo/devel + http://lists.ovirt.org/mailman/listinfo/devel
- - For questions by users, who do not want to be swamped by - technicalities. +- For questions by users, who do not want to be swamped by + technicalities.
- http://lists.ovirt.org/mailman/listinfo/users + http://lists.ovirt.org/mailman/listinfo/users
The developers also hang out on IRC at #vdsm hosted on freenode.net
The latest upstream code can be obtained from GIT:
- git clone https://gerrit.ovirt.org/vdsm + git clone https://gerrit.ovirt.org/vdsm
-Licensing -========= + +## Licensing
Vdsm is provided under the terms of the GNU General Public License, version 2 or later. Please see the COPYING file for complete GPLv2+ @@ -71,5 +70,3 @@ If you modify this program, you may extend this exception to your version, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version. - --- End of readme diff --git a/vdsm.spec.in b/vdsm.spec.in index 2842afa..b91ad3b 100644 --- a/vdsm.spec.in +++ b/vdsm.spec.in @@ -895,7 +895,7 @@ exit 0
%files -%doc README +%doc README.md %doc lib/vdsm/vdsm.conf.sample %doc README.logging %license COPYING