From 663d38d8087bf3ccba78beb7b793c84da9c632eb Mon Sep 17 00:00:00 2001
From: Victor LABORIE <vlaborie@evolix.fr>
Date: Tue, 15 May 2018 14:12:30 +0200
Subject: [PATCH] Add a README.md file

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f8a3fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# KVM tools
+
+This repository contain scripts for managing KVM hypervisors used with DRBD and LVM.
+
+Currently it only contain the add-vm.sh script for create DBRD volumes and virtuals machines.
+
+## Install
+
+Copy add-vm.sh script in /usr/local/sbin/ :
+
+~~~
+install -m 0755 add-vm.sh /usr/local/sbin/add-vm
+~~~
+
+Edit configuration in /etc/evolinux/add-vm.cnf :
+
+~~~
+masterKVMIP=192.168.0.X
+slaveKVMIP=192.168.0.Y
+~~~
+
+## Dry-run mode
+
+You can use the dry-run mode by setting doDryRun var in config file :
+
+~~~
+doDryRun=true
+~~~