aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLexi Winter <lexi@le-fay.org>2025-06-27 17:21:41 +0100
committerLexi Winter <lexi@le-fay.org>2025-06-27 17:21:41 +0100
commitf6a0636fb3466e1457dc8bd50f992c41f7282fdd (patch)
treee2949c04dbbd726e6e7207ee36b78ffdc3e537c0
parentde13f7cae48d56932d107d8c78bad0d474facde1 (diff)
downloadlfvm-f6a0636fb3466e1457dc8bd50f992c41f7282fdd.tar.gz
lfvm-f6a0636fb3466e1457dc8bd50f992c41f7282fdd.tar.bz2
add a README
-rw-r--r--README31
1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..02f37fd
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+lfvm: bhyve virtual machine manager
+===================================
+
+lfvm is a utility for managing bhyve-based virtual machines.
+i wrote it primarily for my own use, but you're welcome to use it too.
+
+requirements
+------------
+
++ FreeBSD
+ (in theory, Illumos could be supported too.)
++ CMake
++ ninja
++ libucl
++ a recent C++ compiler
+
+build and install
+-----------------
+
+% mkdir build
+% cd build
+% cmake -GNinja ..
+% ninja
+% ninja install
+
+questions, comments?
+--------------------
+
+please send any feedback to lexi@le-fay.org, or alternatively you can
+open an issue or pull request on the GitHub repository:
+ https://github.com/llfw/lfvm