Change in vdsm[master]: readme: Covert to markdown format

[Nir Soffer]

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 
---
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

gerrit-hooks has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 1:

* Update tracker: IGNORE, no Bug-Url found
* Check Bug-Url::WARN, no bug url found, make sure header matches 'Bug-Url: ' and is a valid url.
* Check merged to previous::IGNORE,         Not in stable branch (['ovirt-3.6', 'ovirt-4.0'])

[Nir Soffer]

Nir Soffer has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 1:

(1 comment)

https://gerrit.ovirt.org/#/c/65260/1/Makefile.am
File Makefile.am:

Line 19: #
Line 20: TOX_MIN_VERSION = 2.1.1
Line 21: 
Line 22: # We don't want the standard gnu file setup (README, INSTALL, etc.)
Line 23: AUTOMAKE_OPTIONS = foreign
Required to have README.md instead of README.
Line 24: 
Line 25: SUBDIRS = \
Line 26: 	client \
Line 27: 	contrib \

[Nir Soffer]

Nir Soffer has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 1: Verified+1

See https://github.com/nirs/vdsm/tree/github#vdsm-virtual-desktop-server-manager

[Nir Soffer]

Nir Soffer has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 1:

https://github.com/nirs/vdsm/tree/github#vdsm-virtual-desktop-server-manager

[Dan Kenigsberg]

Dan Kenigsberg has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 1:

(1 comment)

https://gerrit.ovirt.org/#/c/65260/1/README.md
File README.md:

Line 21: In order to start vdsm at first try, please perform:
Line 22: 
Line 23:     vdsm-tool configure [--force]
Line 24: 
Line 25: --force flag will override old conf files with vdsm defaults and restart
`--force` maybe?
Line 26: services that were configured (if were already running)
Line 27: 
Line 28: 
Line 29: ## Packaging

gerrit-hooks has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 2:

* Update tracker: IGNORE, no Bug-Url found
* Check Bug-Url::WARN, no bug url found, make sure header matches 'Bug-Url: ' and is a valid url.
* Check merged to previous::IGNORE,         Not in stable branch (['ovirt-3.6', 'ovirt-4.0'])

[Nir Soffer]

Nir Soffer has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 1:

(1 comment)

https://gerrit.ovirt.org/#/c/65260/1/README.md
File README.md:

Line 21: In order to start vdsm at first try, please perform:
Line 22: 
Line 23:     vdsm-tool configure [--force]
Line 24: 
Line 25: --force flag will override old conf files with vdsm defaults and restart
> `--force` maybe?

Updated in currnet version.
Line 26: services that were configured (if were already running)
Line 27: 
Line 28: 
Line 29: ## Packaging

[Nir Soffer]

Nir Soffer has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 2: Verified+1

[Nir Soffer]

Nir Soffer has posted comments on this change.

Change subject: readme: Covert to markdown format
......................................................................

Patch Set 2:

See https://github.com/nirs/vdsm/blob/github/README.md

Change in vdsm[master]: readme: Convert to markdown format

gerrit-hooks has posted comments on this change.

Change subject: readme: Convert to markdown format
......................................................................

Patch Set 3:

* Update tracker: IGNORE, no Bug-Url found
* Check Bug-Url::WARN, no bug url found, make sure header matches 'Bug-Url: ' and is a valid url.
* Check merged to previous::IGNORE,         Not in stable branch (['ovirt-3.6', 'ovirt-4.0'])

Change in vdsm[master]: readme: Convert to markdown format

[Dan Kenigsberg]

Dan Kenigsberg has posted comments on this change.

Change subject: readme: Convert to markdown format
......................................................................

Patch Set 3: Code-Review+2

(1 comment)

https://gerrit.ovirt.org/#/c/65260/3//COMMIT_MSG
Commit Message:

Line 3: AuthorDate: 2016-10-09 00:49:47 +0300
Line 4: Commit:     Dan Kenigsberg 
Line 5: CommitDate: 2016-10-09 13:42:46 -0400
Line 6: 
Line 7: readme: Convert to markdown format
we're open source. no covert operations allowed.
Line 8: 
Line 9: Markdown is nicer to work with and render nicer in github.
Line 10: 
Line 11: Change-Id: I74ce4bcb8bb276e98fc6466ace7709733dd809c1

Change in vdsm[master]: readme: Convert to markdown format

[Dan Kenigsberg]

Dan Kenigsberg has submitted this change and it was merged.

Change subject: readme: Convert to markdown format
......................................................................

readme: Convert to markdown format

Markdown is nicer to work with and render nicer in github.

Change-Id: I74ce4bcb8bb276e98fc6466ace7709733dd809c1
Signed-off-by: Nir Soffer 
Reviewed-on: https://gerrit.ovirt.org/65260
Continuous-Integration: Jenkins CI
Reviewed-by: Dan Kenigsberg 
---
M Makefile.am
R README.md
M vdsm.spec.in
3 files changed, 26 insertions(+), 25 deletions(-)

Approvals:
  Nir Soffer: Verified
  Jenkins CI: Passed CI tests
  Dan Kenigsberg: Looks good to me, approved

Change in vdsm[master]: readme: Convert to markdown format

gerrit-hooks has posted comments on this change.

Change subject: readme: Convert to markdown format
......................................................................

Patch Set 4:

* Update tracker: IGNORE, no Bug-Url found
* Set MODIFIED::IGNORE, no Bug-Url found.