diff --git a/README.md b/README.md index 2078f98..84e96fd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,41 @@ [Phyllome OS](https://wiki.phyllo.me/phyllomeos/context) uses the [kickstart installation method](https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html#chapter-1-introduction) to deploy itself to a specific target computer or virtual machine by means of kickstart files. +Provided that some dependencies are met (`libvirt` is running on your computer, QEMU is installed, etc), one could run the following script to deploy virtual machines, including Phyllome OS itself. + +- Make the script executable: + +``` +chmod +x deploy-vm.sh +``` + +- Execute it and pick `virtual-desktop-hypervisor` when prompted: + +``` +./deploy-vm.sh + +Executing: ./scripts/core-count.sh +System has more than 2 core (nproc --all: 6). +[...]] +10. virtual-desktop-hypervisor +[...] +Enter the number of the file you want to select: 10 +You selected: virtual-desktop-hypervisor + +Starting install... +Retrieving 'vmlinuz' | 16 MB 00:00:00 +Retrieving 'initrd.img' | 161 MB 00:00:05 +Allocating 'virtinst-n0km88yy-vmlinuz' | 16 MB 00:00:00 +Transferring 'virtinst-n0km88yy-vmlinuz' | 16 MB 00:00:00 +Allocating 'virtinst-qxr2jxcb-initrd.img' | 161 MB 00:00:00 +Transferring 'virtinst-qxr2jxcb-initrd.img' | 161 MB 00:00:00 +Allocating 'virtual-desktop-hypervisor.img' | 10 GB 00:00:00 +Creating domain... +``` +After a successfull installation, the virtual machine will shutdown and be ready to use when powered on again. + +## Repository structure + This repository contains such files broken down as: * `ingredients`🥑 🥥 🥭 🥝 🥦 🥬 🥒 🧄: the basic building blocks for assembling Phyllome OS and other derivatives.