Apply Changes from Quickemu PR 1140

README.md is now probably not worth regenerating as no cogging is required and such bits are now in the wiki. The man pages may still be wanted
philclifford · May 4, 2024 · bfd2e4b · bfd2e4b
1 parent 22c4887
commit bfd2e4b
Show file tree

Hide file tree

Showing 16 changed files with 75 additions and 63 deletions.
diff --git a/README-00-hdr.md b/README-00-hdr.md
@@ -1,49 +1,16 @@
 <div align="center">
-
 <img src=".github/logo.png" alt="Quickemu" width="256" />
 
 # Quickemu
 
-**Quickly create and run optimised Windows, macOS and Linux desktop virtual machines:**
-
-</div>
-
-``` shell
-quickget ubuntu-mate 22.04
-quickemu --vm ubuntu-mate-22.04.conf
-```
-
-<div align="center">
+**Quickly create and run optimised Windows, macOS and Linux virtual machines:**
 
 <img src=".github/screenshot.png" alt="Quickemu Screenshot" />
 
-**Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>.**
-
-Quickemu is available in the repositories of the following distros
-(packaging status by [Repology.org](https://repology.org/)):
-
-<table>
-<tbody>
-<tr valign="top">
-<td>
-
-[![Packaging
-status of quickemu](https://repology.org/badge/vertical-allrepos/quickemu.svg?header=quickemu)](https://repology.org/project/quickemu/versions)
-
-</td>
-<td>
-
-[![Packaging
-status](https://repology.org/badge/vertical-allrepos/quickgui.svg?header=quickgui)](https://repology.org/project/quickgui/versions)
-
-</td>
-</tr>
-</tbody>
-</table>
+**Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>**
 
 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)
-
 </div>
 
diff --git a/README-01-Intro.md b/README-01-Intro.md
@@ -0,0 +1 @@
+quickemu.1-04-intro.md
diff --git a/README-02-Features.md b/README-02-Features.md
@@ -0,0 +1 @@
+quickemu.1-05-features01.md
diff --git a/README-03-Quickstart.md b/README-03-Quickstart.md
@@ -0,0 +1,16 @@
+# 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.
diff --git a/README-04-Documentation.md b/README-04-Documentation.md
@@ -0,0 +1,12 @@
+# Documentation
+
+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) 📚️
diff --git a/README-05-Contribution.md b/README-05-Contribution.md
@@ -0,0 +1,9 @@
+# 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 ✨
+- [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖
diff --git a/XXquickemu.1-14-AllquickemuOptions-02coggged.md b/XXquickemu.1-14-AllquickemuOptions-02coggged.md
@@ -8,7 +8,7 @@ import subprocess
 
 import cog
 # cannot use check_result() because of non-zero return
-result=subprocess.run(["./quickemu", "--help"], capture_output=True, text=True)
+result=subprocess.run(["./get_quickemu_help"], capture_output=True, text=True)
 help=result.stdout
 cog.out(f"\n``` text\n{help}\n```\n")
 ]]] -->

diff --git a/build_manuals b/build_manuals
@@ -9,8 +9,10 @@
 echo quickemu.1-* > quickemu.lst
 echo quickget.1-00-header.md quickemu.1-0[7-9]* quickemu.1-1[0-3]* quickget.1-09-footer.md > quickget.lst
 
-echo quickemu.1-0[4-5]* README-06-Install.md quickemu.1-0[6-9]* \
-quickemu.1-1[0-3]* quickemu_conf.1-01-spiceheadless.md README-135-accessibility.md README-135-confoptions.md quickemu.1-1[4-9]* quickemu.1-2* > README.lst
+## Significantly reduces weight in Readme
+# echo quickemu.1-0[4-5]* README-06-Install.md quickemu.1-0[6-9]* \
+# quickemu.1-1[0-3]* quickemu_conf.1-01-spiceheadless.md README-135-accessibility.md README-135-confoptions.md quickemu.1-1[4-9]* quickemu.1-2*
+echo README-0[1-5]* > README.lst
 #
 echo quickemu_conf.1-00-hdr.md  README-135-confoptions.md quickemu_conf.1-05-footer.md > quickemu_conf.lst
 # update date front-matter
@@ -27,10 +29,11 @@ ln -sf ../quickemu ../quickget .
 cog -e -d -o quickemu.1-08-OtherOperatingSystems01.md XXquickemu.1-08-OtherOperatingSystems01.md
 cog -e -d -o quickemu.1-14-AllquickemuOptions-02coggged.md XXquickemu.1-14-AllquickemuOptions-02coggged.md 
 
-pandoc -s $(cat README.lst)  -f markdown -t markdown  | sed 's/`<kbd>`{=html}/<kbd>/; s/`<\/kbd>`{=html}/<\/kbd>/; s/```{=html}//' > README_main.md
+pandoc -s $(cat README.lst)  -f markdown -t markdown  > README_main.md
+#| sed 's/`<kbd>`{=html}/<kbd>/; s/`<\/kbd>`{=html}/<\/kbd>/; s/```{=html}//' > README_main.md
 #
 cat README-00-hdr.md README_main.md >../README.md
-( cd .. ; cog -r README.md )
+# ( cd .. ; cog -r README.md )
 
 
 

diff --git a/get_quickemu_help b/get_quickemu_help
@@ -0,0 +1,4 @@
+#!/bin/bash
+./quickemu --help | tail +12
+#grep '^  --'
+#|grep -v '^---' 
diff --git a/get_quickget_help b/get_quickget_help
@@ -1,2 +1,2 @@
 #!/bin/bash
-./quickget --help|grep '^ -'|grep -v '^---' 
+./quickget --help|grep '^  -'|grep -v '^---' 
diff --git a/quickemu.1-01-head.md b/quickemu.1-01-head.md
@@ -3,7 +3,7 @@ title: QUICKEMU
 section: 1
 header: Quickemu User Manual
 footer: quickemu
-date: May  2, 2024
+date: May  4, 2024
 author: Martin Wimpress
 ---
 

diff --git a/quickemu.1-04-intro.md b/quickemu.1-04-intro.md
@@ -1,14 +1,15 @@
 
-## Introduction
+# Introduction
 
 **Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) that attempts to
 automatically *"do the right thing"*, rather than expose exhaustive configuration options.
 You decide what operating system you want to run, and Quickemu will figure out the best
 way to do it for you.
 
-The original objective of the project was to enable [quick testing of
-Linux distributions](#creating-linux-guests-) where the virtual machine configurations can be
+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 configurations can be
 stored anywhere (such as external USB storage or your home directory)
 and no elevated permissions are required to run the virtual machines.
 
-**Quickemu now also includes comprehensive support for [macOS](#creating-macos-guests-) and [Windows](#creating-windows-guests-)**.
+**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.
diff --git a/quickemu.1-05-features01.md b/quickemu.1-05-features01.md
@@ -1,10 +1,10 @@
-## Features
+# Features
 
 - **macOS** Sonoma, Ventura, Monterey, Big Sur, Catalina, Mojave & High Sierra
 - **Windows** 10 and 11 including TPM 2.0
 - [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
     flavours](https://ubuntu.com/download/flavours)**
-- **Over 360 operating system editions are supported!**
+- **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

diff --git a/quickemu.1-08-OtherOperatingSystems01.md b/quickemu.1-08-OtherOperatingSystems01.md
@@ -2,19 +2,17 @@ You can also use `quickget` with advanced options :
 
 
 ``` text
- -[12345]              <os>           : Show info* about OS
- --download       (-d) <os> <re> [ed] : Download the ISO only; no VM configuration
- --create-config (-cc) <os> [path/url]: Create default VM config for image
- --open-homepage  (-o) <os>           : Open homepage for the OS
- --version        (-v)                : Show version
- --help           (-h)                : Show this help message
- --url            (-u) <os> <re> [ed] : Show download URL for an OS release/edition
- --url-all       (-ua) <os>           : Show all download URLs for an OS
- --check          (-c) <os> [re] [ed] : Check download an OS release/edition is available
- --check-all     (-ca) <os>           : Check all downloads for an OS are available
- --list           (-l)                : List all supported systems in plain text
- --list-csv      (-lc)                : List all supported systems in csv format
- --list-json     (-lj)                : List all supported systems in json format
+  -[12345]              <os>           : Show info* about OS
+  --download       (-d) <os> <re> [ed] : Download image; no VM configuration
+  --create-config (-cc) <os> [path/url]: Create default VM config for image
+  --open-homepage  (-o) <os>           : Open homepage for the OS
+  --version        (-v)                : Show version
+  --help           (-h)                : Show this help message
+  --url            (-u) [os] [re] [ed] : Show image URL(s)
+  --check          (-c) [os] [re] [ed] : Check image URL(s)
+  --list           (-l)                : List all supported systems
+  --list-csv      (-lc)                : List everything in csv format
+  --list-json     (-lj)                : List everything in json format
 
 ```
 

diff --git a/quickemu_conf.1-00-hdr.md b/quickemu_conf.1-00-hdr.md
@@ -3,7 +3,7 @@ title: QUICKEMU_CONF
 section: 1
 header: Quickemu Configuration Manual
 footer: quickemu_conf
-date: May  2, 2024
+date: May  4, 2024
 author: Martin Wimpress
 ---
 

diff --git a/quickget.1-00-header.md b/quickget.1-00-header.md
@@ -3,7 +3,7 @@ title: QUICKGET
 section: 1
 header: Quickget User Manual
 footer: quickget
-date: May  2, 2024
+date: May  4, 2024
 author: Martin Wimpress
 ---