aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 30 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0156622..a64544d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,32 @@
-KVMX: QEMU KVM Wrapper
-======================
+KVMX: vagrant-like QEMU KVM Wrapper
+===================================
+
+KVMX is a lightweight implementation of a virtual machine manager
+inspired by vagrant.
+
+It may be used for development or as a wrapper for GUI isolation.
+
+This is simple stuff. Don't use it if you need any complex behavior
+or integration. In the other hand, if you're looking for a small
+application that doesn't depend on software installed from unstrusted
+sources, you'll feel welcome here :)
+
+## Instalation
+
+Simply clone it and add to your `$PATH`:
+
+ git clone https://git.fluxo.info/kvmx
+ cd kvmx && git verify-commit HEAD
+
+## Basic usage
+
+ kvmx init [project-name] [project-folder] # initialize
+ kvmx edit [project-name] # customize
+ kvmx up [project-name] # bring it up!
+
+If no project name is specified, the current folder name is assumed as the project name.
+If no folder is specified, the current folder is assumed as the project home.
+
+## Further reading
-Wrapper to provide easy to use GUI isolation.
See https://blog.fluxo.info/suckless/virtual for details.