README.md regenerated, with only pandoc markdown pedantry differences

This commit is contained in:
Phil Clifford 2024-05-04 18:50:39 +01:00 committed by Martin Wimpress
parent 19d09556c6
commit 67893f5cb1
1 changed files with 62 additions and 27 deletions

View File

@ -4,6 +4,7 @@
# Quickemu # Quickemu
**Quickly create and run optimised Windows, macOS and Linux virtual machines:** **Quickly create and run optimised Windows, macOS and Linux virtual machines:**
<img src=".github/screenshot.png" alt="Quickemu Screenshot" /> <img src=".github/screenshot.png" alt="Quickemu Screenshot" />
**Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>** **Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>**
@ -22,15 +23,19 @@ decide what operating system you want to run, and Quickemu will figure
out the best way to do it for you. out the best way to do it for you.
The original objective of the project was to [enable quick testing of The original objective of the project was to [enable quick testing of
Linux distributions](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) where the virtual machine Linux
configurations can be stored anywhere (such as external USB storage or distributions](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
your home directory) and no elevated permissions are required to run the where the virtual machine configurations can be stored anywhere (such as
virtual machines. 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), **Today, Quickemu includes comprehensive support for
[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. [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 # Features
- **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave & - **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave &
High Sierra High Sierra
@ -58,40 +63,70 @@ virtual machines.
# Quick start # 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 ``` shell
quickget nixos unstable 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 ``` shell
quickemu --vm nixos-unstable.conf 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.
# Documentation # 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) 💾 - [**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 Linux virtual
- [**Create Windows virtual machines**](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟 machines**](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-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) 🤓 - [**Create macOS virtual
- [**Alternative frontends**](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) 🧑‍💻 machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines)
- [**References**](https://github.com/quickemu-project/quickemu/wiki/08-References) 📚️ 🍏
- [**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 # Contributing
We welcome contributions to Quickemu. We welcome contributions to Quickemu.
- Help other Quickemu users by answering questions in the [Quickemu Discussions](https://github.com/quickemu-project/quickemu/discussions) 🛟 - Help other Quickemu users by answering questions in the [Quickemu
- 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) 📖 Discussions](https://github.com/quickemu-project/quickemu/discussions)
- 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 ✨ - Improve the documentation in [this
- [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖 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 ✨
- [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖