diff --git a/README.md b/README.md index fb51678..59face5 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,21 @@ Quickemu -

Simple shell script to manage Qemu virtual machines.

+

Simple shell script to "manage" Qemu virtual machines.

Quickemu Screenshot

Made with 💝 for

## Introduction -Quickemu is a very simple script to "manage" Qemu virtual machines. Each virtual -machine configuration is broadly the same requiring minimal setup. The main -objective of the project is to enable quick testing of desktop Linux -distributions where the virtual machines can be stored anywhere, such as external -USB storage. +Quickemu is a very simple script to "manage" Qemu virtual machines. Each +virtual machine configuration is broadly the same requiring minimal setup. The +main objective of the project is to enable quick testing of desktop Linux +distributions where the virtual machines can be stored anywhere, such as +external USB storage. -See the video where I explain my motivations for creating this script. +Quickemu is opinionated and will attempt to *"do the right thing"* rather than +expose rich configuration options. See the video where I explain some of my +motivations for creating this script. [![Replace VirtualBox with Bash & QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/watch?v=AOTYWEgw0hI) @@ -62,6 +64,24 @@ disk=128G ./quickemu --vm ubuntu-focal-desktop.conf ``` +Which will output something like this: + +``` +Starting /media/martin/Quickemu/ubuntu-focal-desktop.conf + - BIOS: Legacy + - Disk: /media/martin/Quickemu/ubuntu/focal-desktop-amd64.qcow2 + - Size: 64G + - ISO: /media/martin/Quickemu/ubuntu/focal-desktop-amd64.iso + - CPU: 4 Core(s) + - RAM: 4G + - UI: sdl + - GL: on + - VIRGL: on + - Monitor: 1664x936 + - smbd: /home/martin will be exported to the guest via smb://10.0.2.4/qemu + - ssh: 22221/tcp is connected. Login via 'ssh user@localhost -p 22221' +``` + Here are the full usage instructions: ```