From c69bded135703f204b41a4bf95e539047e52b76a Mon Sep 17 00:00:00 2001 From: Phil Clifford Date: Mon, 13 May 2024 02:21:49 +0100 Subject: [PATCH] docs: Regenerated README updated pandoc version and improved pandoc incantation --- README.md | 141 ++++++++++++++++++++++-------------------------------- 1 file changed, 58 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index 79e71df..f0e0e54 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@
+ Quickemu # Quickemu @@ -6,18 +7,21 @@ **Quickly create and run optimised Windows, macOS and Linux virtual machines:** **Made with πŸ’ for Tux (Linux)** +
+

-  Discord  -  Mastodon  -  Twitter  -  LinkedIn  +Β DiscordΒ  +Β MastodonΒ  +Β TwitterΒ  +Β LinkedInΒ 

# Introduction **Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) that -automatically *"does the right thing"* when creating virtual machines. No +automatically *β€œdoes the right thing”* when creating virtual machines. No requirement for exhaustive configuration options. You decide what operating system you want to run and Quickemu takes care of the rest πŸ€– @@ -30,110 +34,81 @@ where the virtual machines and their configuration can be stored anywhere (such as external USB storage or your home directory) and no elevated permissions are required to run the virtual machines. -**Today, Quickemu includes comprehensive support for -[macOS](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines), -[Windows](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)**, -most of the BSDs, novel non-Linux operating systems such as FreeDOS, -Haiku, KolibriOS, OpenIndiana, ReactOS, and more. +**Today, Quickemu includes comprehensive support for [macOS](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines), +[Windows](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)**, most of the BSDs, novel non-Linux operating systems such as FreeDOS, Haiku, KolibriOS, OpenIndiana, ReactOS, and more. # Features -- **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina & Mojave -- **Windows** 10 and 11 including TPM 2.0 -- **Windows Server** 2022 2019 2016 2012-r2 -- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu - flavours](https://ubuntu.com/download/flavours)** -- **Nearly 1000 operating system editions are supported!** -- Full SPICE support including host/guest clipboard sharing -- VirtIO-webdavd file sharing for Linux and Windows guests -- VirtIO-9p file sharing for Linux and macOS guests -- [QEMU Guest Agent - support](https://wiki.qemu.org/Features/GuestAgent); provides access - to a system-level agent via standard QMP commands -- Samba file sharing for Linux, macOS and Windows guests (*if `smbd` - is installed on the host*) -- VirGL acceleration -- USB device pass-through -- Smartcard pass-through -- Automatic SSH port forwarding to guests -- Network port forwarding -- Full duplex audio -- Braille support -- EFI (with or without SecureBoot) and Legacy BIOS boot +- **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina & Mojave +- **Windows** 10 and 11 including TPM 2.0 +- **Windows Server** 2022 2019 2016 2012-r2 +- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu + flavours](https://ubuntu.com/download/flavours)** +- **Nearly 1000 operating system editions are supported!** +- Full SPICE support including host/guest clipboard sharing +- VirtIO-webdavd file sharing for Linux and Windows guests +- VirtIO-9p file sharing for Linux and macOS guests +- [QEMU Guest Agent + support](https://wiki.qemu.org/Features/GuestAgent); provides access + to a system-level agent via standard QMP commands +- Samba file sharing for Linux, macOS and Windows guests (*if `smbd` + is installed on the host*) +- VirGL acceleration +- USB device pass-through +- Smartcard pass-through +- Automatic SSH port forwarding to guests +- Network port forwarding +- Full duplex audio +- Braille support +- EFI (with or without SecureBoot) and Legacy BIOS boot # Quick start -[Once Quickemu is -installed](https://github.com/quickemu-project/quickemu/wiki/01-Installation), -there are two simple steps to create and run a virtual machine: +[Once Quickemu is installed](https://github.com/quickemu-project/quickemu/wiki/01-Installation), there are two simple steps to create and run a virtual machine: -- `quickget` automatically downloads the ISO image for the operating - system you want to run and creates a configuration file for the - virtual machine. +- `quickget` automatically downloads the ISO image for the operating system you want to run and creates a configuration file for the virtual machine. ``` shell quickget nixos unstable ``` -- `quickemu` starts the virtual machine using the configuration file - created by `quickget`. +- `quickemu` starts the virtual machine using the configuration file created by `quickget`. ``` shell quickemu --vm nixos-unstable.conf ``` -- Execute `quickget` (with no arguments) to see a list of all the - supported operating systems. +Execute `quickget` (with no arguments) to see a list of all the supported operating systems. ## Demo -
+
+ + + +
# Documentation -The wiki describes how to get up and running with Quickemu and also -covers more advanced configuration and usage. +The wiki describes how to get up and running with Quickemu and also covers more advanced configuration and usage. -- [**Installation**](https://github.com/quickemu-project/quickemu/wiki/01-Installation) - πŸ’Ύ -- [**Create Linux virtual - machines**](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) - 🐧 -- [**Create macOS virtual - machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines) - 🍏 -- [**Create Windows virtual - machines**](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) - πŸͺŸ -- [**Advanced quickemu - configuration**](https://github.com/quickemu-project/quickemu/wiki/05-Advanced-quickemu-configuration) - πŸ”§ -- [**Advanced quickget - features**](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) - πŸ€“ -- [**Alternative - frontends**](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) - πŸ§‘β€πŸ’» -- [**References**](https://github.com/quickemu-project/quickemu/wiki/08-References) - πŸ“šοΈ +- [**Installation**](https://github.com/quickemu-project/quickemu/wiki/01-Installation) πŸ’Ύ +- [**Create Linux virtual machines**](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) 🐧 +- [**Create macOS virtual machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines) 🍏 +- [**Create Windows virtual machines**](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) πŸͺŸ +- [**Advanced quickemu configuration**](https://github.com/quickemu-project/quickemu/wiki/05-Advanced-quickemu-configuration) πŸ”§ +- [**Advanced quickget features**](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) πŸ€“ +- [**Alternative frontends**](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) πŸ§‘β€πŸ’» +- [**References**](https://github.com/quickemu-project/quickemu/wiki/08-References) πŸ“šοΈ # Contributing We welcome contributions to Quickemu. -- Help other Quickemu users by answering questions in the [Quickemu - Discussions](https://github.com/quickemu-project/quickemu/discussions) - πŸ›Ÿ -- Improve the documentation in [this - README](https://github.com/quickemu-project/quickemu/edit/master/README.md) - and the [Quickemu - Wiki](https://github.com/quickemu-project/quickemu/wiki) πŸ“– -- File bug reports and feature requests in the [Quickemu - Issues](https://github.com/quickemu-project/quickemu/issues) πŸ“ -- Submit [Quickemu Pull - requests](https://github.com/quickemu-project/quickemu/pulls) to fix - bugs 🐞 or add new features ✨ - - Follow our [guide to adding a new OS to quickget](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features#adding-a-new-os-to-quickget) - - Commit messages must [conform to the Conventional Commits - specification](https://www.conventionalcommits.org/) -- [Sponsor the project](https://github.com/sponsors/flexiondotorg) πŸ’– +- Help other Quickemu users by answering questions in the [Quickemu Discussions](https://github.com/quickemu-project/quickemu/discussions) πŸ›Ÿ +- Improve the documentation in [this README](https://github.com/quickemu-project/quickemu/edit/master/README.md) and the [Quickemu Wiki](https://github.com/quickemu-project/quickemu/wiki) πŸ“– +- File bug reports and feature requests in the [Quickemu Issues](https://github.com/quickemu-project/quickemu/issues) πŸ“ +- Submit [Quickemu Pull requests](https://github.com/quickemu-project/quickemu/pulls) to fix bugs 🐞 or add new features ✨ + - Follow our [guide to adding a new OS to quickget](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features#adding-a-new-os-to-quickget) + - Commit messages must [conform to the Conventional Commits specification](https://www.conventionalcommits.org/). +- [Sponsor the project](https://github.com/sponsors/flexiondotorg) πŸ’–