summarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevdog2019-11-20 10:50:16 -0600
committerKevdog2019-11-20 10:50:16 -0600
commit6e5f258349cdd60b615360f984effaa04b3729ff (patch)
treecc71c6180fafc6fc6305c0e4c4024a4f72da36b3
parentc3acd3246b875940ae4a7270033f552bd7b1e2c8 (diff)
downloadaur-6e5f258349cdd60b615360f984effaa04b3729ff.tar.gz
modified: README.md
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index f6cc4986f60..b1db4196f66 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,16 @@
# xe-guest-utilities-git
-###Purpose
+### Purpose
xe-guest-utilities is an add-on package for the [Xen](https://xenproject.org/developers/teams/xen-hypervisor/) and [xcp-ng](https://xcp-ng.org/) hypervisors. As per [documentation](https://xenproject.org/developers/teams/xen-hypervisor/) these tools:
- Report extra VM info (that only the Operating system can know, not your underlying hypervisor), like VM IP address, kernel version etc.
- Communicate with the OS in case of quiesce snapshots (Windows and its VSS)
- Allow sending signals to the OS (clean reboot, hotplug hardware etc.)
This package provides a service file which can be activated/enabled by systemd to provide these features to your VM running with Xen/xcp-ng.
-###Source Code
+### Source Code
xe-guest-utilities pulls its sourcecode from the [Xenserver](https://github.com/xenserver/xe-guest-utilities) github repository. The source code requires a [Go development environment](https://golang.org/doc/install) in order to successfully compile the code. This script should automatically download the go-pie package, compile and install the script.
-###Installation
+### Installation
The following files are installed by the package: (Listed here in case manual removal is necessary)
- /usr/share/licenses/xe-guest-utilities-git/LICENSE
- /usr/share/oem/xs/xe-daemon
@@ -24,7 +24,7 @@ The following files are installed by the package: (Listed here in case manual re
- /usr/bin/xenstore-write
-###Activation
+### Activation
Once xe-guest-utilities-git is installed, the service can be started (as root):
```
systemctl start xe-guest-utilities.service