RomanNum3ral
/
quickemu
mirror of https://github.com/quickemu-project/quickemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Regenerated README 

updated pandoc version and improved pandoc incantation
This commit is contained in:
Phil Clifford 2024-05-13 02:21:49 +01:00 committed by Martin Wimpress
parent 212450765b
commit c69bded135
1 changed files with 58 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@ -1,4 +1,5 @@
<div align="center"> <div align="center">
<img src=".github/logo.png" alt="Quickemu" width="256" /> <img src=".github/logo.png" alt="Quickemu" width="256" />
# Quickemu # Quickemu
@ -6,18 +7,21 @@
**Quickly create and run optimised Windows, macOS and Linux virtual machines:** **Quickly create and run optimised Windows, macOS and Linux virtual machines:**
**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)"/>**
</div> </div>
<p align="center"> <p align="center">
&nbsp;<a href="https://wimpysworld.io/discord" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/712850672223125565?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&labelColor=%234253e8&color=%23e4e2e2"></a>&nbsp;  <a href="https://wimpysworld.io/discord" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/712850672223125565?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&labelColor=%234253e8
&nbsp;<a href="https://fosstodon.org/@wimpy" target="_blank"><img alt="Mastodon" src="https://img.shields.io/badge/Mastodon-6468fa?style=for-the-badge&logo=mastodon&logoColor=%23ffffff"></a>&nbsp; &color=%23e4e2e2"></a> 
&nbsp;<a href="https://twitter.com/m_wimpress" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-303030?style=for-the-badge&logo=x&logoColor=%23ffffff"></a>&nbsp;  <a href="https://fosstodon.org/@wimpy" target="_blank"><img alt="Mastodon" src="https://img.shields.io/badge/Mastodon-6468fa?style=for-the-badge&logo=mastodon&logoColor=%23ffffff"></a> 
&nbsp;<a href="https://linkedin.com/in/martinwimpress" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a>&nbsp;  <a href="https://twitter.com/m_wimpress" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-303030?style=for-the-badge&logo=x&logoColor=%23ffffff"></a> 
 <a href="https://linkedin.com/in/martinwimpress" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a> 
</p> </p>
# Introduction # Introduction
**Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) that **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 requirement for exhaustive configuration options. You decide what operating
system you want to run and Quickemu takes care of the rest 🤖 system you want to run and Quickemu takes care of the rest 🤖
@ -30,11 +34,8 @@ 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 as external USB storage or your home directory) and no elevated permissions are
required to run the virtual machines. required to run the virtual machines.
**Today, Quickemu includes comprehensive support for **Today, Quickemu includes comprehensive support for [macOS](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines),
[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.
[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
@ -63,77 +64,51 @@ Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
# Quick start # Quick start
[Once Quickemu is [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:
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 - `quickget` automatically downloads the ISO image for the operating system you want to run and creates a configuration file for the virtual machine.
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 - `quickemu` starts the virtual machine using the configuration file created by `quickget`.
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 Execute `quickget` (with no arguments) to see a list of all the supported operating systems.
supported operating systems.
## Demo ## Demo
<div align="center"><a href="https://asciinema.org/a/658148?autoplay=1" target="_blank"><img src="https://asciinema.org/a/658148.svg" /></a></div> <div align="center">
<a href="https://asciinema.org/a/658148?autoplay=1" target="_blank"><img src="https://asciinema.org/a/658148.svg" /></a>
</div>
# Documentation # Documentation
The wiki describes how to get up and running with Quickemu and also The wiki describes how to get up and running with Quickemu and also covers more advanced configuration and usage.
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 Linux virtual - [**Create macOS virtual machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines) 🍏
machines**](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-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) 🔧
- [**Create macOS virtual - [**Advanced quickget features**](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) 🤓
machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines) - [**Alternative frontends**](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) 🧑‍💻
🍏 - [**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 - Help other Quickemu users by answering questions in the [Quickemu Discussions](https://github.com/quickemu-project/quickemu/discussions) 🛟
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) 📁
- Improve the documentation in [this - Submit [Quickemu Pull requests](https://github.com/quickemu-project/quickemu/pulls) to fix bugs 🐞 or add new features ✨
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) - 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 - Commit messages must [conform to the Conventional Commits specification](https://www.conventionalcommits.org/).
specification](https://www.conventionalcommits.org/)
- [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖 - [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖