diff --git a/README.md b/README.md index 1bc6179..c011f1f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # README -qq2clone is a linux tool to simplify creating and managing copy-on-write clones of template QEMU/KVM virtual machines. It can perform batch operations in case you are working with multiple clones. For much more information, there is a markdown version of the manual page you can read above ([man.md](https://git.j-g-web.com/jesse/qq2clone/src/branch/master/man.md)). +qq2clone is a linux tool to simplify creating and managing copy-on-write clones of template QEMU/KVM virtual machines. It can perform batch operations in case you are working with multiple clones. There is a version of the manual page you can read online above ([man.md](https://git.j-g-web.com/jesse/qq2clone/src/branch/master/man.md)). qq2clone has these dependences: -* virsh (qq2clone has started the transition to use the libvirt API directly, this will not remain a dependency forever) +* virsh (qq2clone has started transitioning to use the libvirt API directly, this will not remain a dependency forever) * Bash 4.0+ * sqlite3 * xmllint (from libxml2) @@ -24,10 +24,10 @@ chmod +x .qq2clone_installer.bash && # FAQ -## Is this really 3000 lines of Bash? In 2021?! +## How do I use this thing? -Yep! I am aware that more popular, modern scripting languages like Python exist, but Bash is more than sufficiently capable for a project of this nature. The reason I chose it specifically was as an opportunity to further develop my Bash skills. Similarly, the lv_api_do helper application is written in C rather than Python (for which libvirt API bindings exist) because I hadn't written any C in a long time and it was an opportunity to re-familiarize myself with the language. +The [manual](https://git.j-g-web.com/jesse/qq2clone/src/branch/master/man.md) is quite detailed, and there is an [examples](https://git.j-g-web.com/jesse/qq2clone/src/branch/master/man.md#examples) section that may be helpful. -# EXAMPLES +## Why use Bash and C when this could all be written in Python? -TODO: I will flesh out this section later, for now check out the examples section in man.md +Just to improve my Bash skills and gain a tiny bit of familiarity with C. Writing this in Python would certainly have been easier.