diff --git a/README.md b/README.md index 3140d81..a0594c7 100644 --- a/README.md +++ b/README.md @@ -17,29 +17,38 @@ distributions where the virtual machines can be stored anywhere, such as external USB storage. Quickemu is opinionated and will attempt to *"do the right thing"* rather than -expose rich configuration options. Quickemu is a frontend to [QEMU](https://www.qemu.org/). See the video where I explain some of my motivations for creating this script. +expose rich configuration options. Quickemu is a wrapper for [QEMU](https://www.qemu.org/). See the video where I explain some of my motivations for creating this script. We have a Discord for this project: [![Discord](https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)](https://discord.gg/sNmz3uw) [![Replace VirtualBox with Bash & QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/watch?v=AOTYWEgw0hI) -## Installation +## Requirements -### Install Quickemu +Essential requirements: -Clone this repository: + * [QEMU](https://www.qemu.org/) 6.0.0 or newer + * [Coreutils](https://www.gnu.org/software/coreutils/) + * [procps](https://gitlab.com/procps-ng/procps) + * [usbutils](https://github.com/gregkh/usbutils) + * [Wget](https://www.gnu.org/software/wget/) + * [xrandr](https://gitlab.freedesktop.org/xorg/app/xrandr) -``` -git clone https://github.com/wimpysworld/quickemu.git -``` +Optional requirements: + + * `rot13` to *"decrypt"* the macOS OSK key; found in the `bsdgames` package in Debian/Ubuntu + * `smbd` to export user home directory from the host to the guest VM; found in the `samba` package in Debian/Ubuntu -### Install QEMU +## Install Quickemu -#### Ubuntu +### Ubuntu + +Quickemu is available from a PPA for Ubuntu users. The Quickemu PPA also +includes a back port of QEMU 6.0.0 for 20.04 (Focal) and 21.04 (Hirsute). ```bash sudo apt-add-repository ppa:flexiondotorg/quickemu -sudo apt install qemu-system +sudo apt install quickemu ``` ## Usage @@ -166,15 +175,6 @@ Starting /media/martin/Quickemu/windows10.conf ### macOS -#### Optional extras for macOS - -If you want to run macOS then `quickemu` requires some additional utilities. -`rot13` from `bsdgames` is used to *"decrypt"* the OSK key. - -``` -sudo apt install bsdgames wget -``` - There are some considerations when running macOS via Quickemu. * `quickemu` will automatically download the required [Clover EFI bootloader](https://sourceforge.net/projects/cloverefiboot/) and OVMF firmware from [the macOS-Simple-KVM project](https://github.com/foxlet/macOS-Simple-KVM). @@ -271,15 +271,6 @@ You can also pass optional parameters ## TODO - - [x] Create desktop launcher for a VM + - [ ] SPICE support - [ ] Improve disk management - - [x] Add USB pass-through support - - [x] Fix Virgil 3D on EFI boot - - [x] Add Windows support - - [x] Get QEMU `-audiodev` working for audio input - - [x] Make display configuration more robust - - [x] Improve snapshot management - - [x] Improve stdout presentation - - [x] Make disk image size configurable - [ ] [Add Faux OEM](https://code.launchpad.net/~ubuntu-installer/ubiquity/+git/ubiquity/+merge/379899) - - [x] Improve SMB Management