From 0c95ac28b75e247024cb7efa5c9e66a48ff80fcb Mon Sep 17 00:00:00 2001 From: Martin Wimpress Date: Thu, 2 May 2024 18:24:08 +0100 Subject: [PATCH] docs: add quickstart --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index c2ed1bb..c122eb0 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,23 @@ virtual machines. - EFI (with or without SecureBoot) and Legacy BIOS boot - Graphical user interfaces available +## 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: + +- `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`. + +```shell +quickemu --vm nixos-unstable.conf +``` +- Execute `quickget` (with no arguments) to see a list of all the supported operating systems. + ## Documentation The wiki describes how to quickly get up and running with `quickemu` and also covers more advanced configuration and usage.