more wiki linkage

philclifford · Apr 22, 2024 · ddfea9d · ddfea9d
1 parent ac43a19
commit ddfea9d
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 23 deletions.
diff --git a/README-06-Install.md b/README-06-Install.md
@@ -1,6 +1,7 @@
-## Installation
+## [Installation](https://github.com/quickemu-project/quickemu/wiki/01-Installation)
 
-### Arch Linux hosts
+
+### [Arch Linux hosts](https://github.com/quickemu-project/quickemu/wiki/01-Installation#arch-linux)
 
 Quickemu is available from the AUR (Arch user repository), and can be
 installed via any AUR helper. Assuming your AUR helper is yay, Run the
@@ -10,16 +11,16 @@ following command:
 yay -Sy quickemu
 ```
 
-### Debian and derivatives
+### [Debian and derivatives](https://github.com/quickemu-project/quickemu/wiki/01-Installation#debian-and-derivatives)
 
-A [.deb package is available for Debian and derivatives in this project's GitHub releases page](https://github.com/quickemu-project/quickemu/releases).
+A [.deb package](https://github.com/quickemu-project/quickemu/releases) is available for Debian and derivatives in this project's GitHub releases page.
 Download the .deb and install it with `apt-get`.
 
 ``` shell
 sudo apt-get install ./quickemu_x.y.z-1_all.deb
 ```
 
-### Ubuntu hosts
+### [Ubuntu hosts](https://github.com/quickemu-project/quickemu/wiki/01-Installation#ubuntu)
 
 Quickemu is available from a PPA for Ubuntu users. The Quickemu PPA also
 includes a back port of QEMU 6.0.0 for 20.04 (Focal) and 21.04
@@ -32,7 +33,7 @@ sudo apt update
 sudo apt install quickemu
 ```
 
-### NixOS hosts
+### [NixOS hosts](https://github.com/quickemu-project/quickemu/wiki/01-Installation#nixos-hosts)
 
 To quickly try quickemu:
 
@@ -63,9 +64,11 @@ To install via Flakes:
 # TODO (flake users, please add an example!)
 ```
 
-### Other Linux hosts (installing from source)
+### [Other Linux hosts (installing from source)](https://github.com/quickemu-project/quickemu/wiki/01-Installation#any-linux-installing-from-source)
 
 ``` shell
 git clone --filter=blob:none https://github.com/quickemu-project/quickemu
 cd quickemu
+# optionally
+sudo make install
 ```
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: April 21, 2024
+date: April 22, 2024
 author: Martin Wimpress
 ---
 

diff --git a/quickemu.1-06a-GUI.md b/quickemu.1-06a-GUI.md
@@ -1,4 +1,6 @@
-## GUI (quickgui)
+## [Alternative Frontends](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends)
+
+### Quickgui
 
 While `quickemu` and `quickget` are designed for the terminal, a
 graphical user interface is also available:
@@ -17,10 +19,10 @@ Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and
 [Philipp Kiemle](https://github.com/daPhipz) for creating the
 **[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨
 
-## TUI (qqx)
+### qqX
 
-From Nov 2023, there is also a multi option desktop integrated text
-interface, the **quickemu quickget X terminal project**, a.k.a. **qqX**,
+There is also a multi option desktop integrated text
+interface, the **quickemu quickget X terminal project**, or **qqX**,
 with lots of unique tools and utilities to help you make
 light work of installations, snapshots and disk management
 

diff --git a/quickemu.1-07-Ubuntus01.md b/quickemu.1-07-Ubuntus01.md
@@ -3,3 +3,6 @@
 
 All the official Ubuntu flavours are supported, just replace `ubuntu` with your
 preferred flavour.
+
+The project [wiki](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) may have further information.
+
diff --git a/quickemu.1-08-OtherOperatingSystems01.md b/quickemu.1-08-OtherOperatingSystems01.md
@@ -1,19 +1,44 @@
-You can also use `quickget` with options to:
+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
+ --check          (-c) <os> [re] [ed] : Check download an OS release/edition is available
+ --url-all       (-ua) <os>           : Show all download URLs for an OS
+ --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
+ --list-urls     (-lu)                : List all supported systems download URLs
+ --test-urls     (-tu)                : Check all downloads for all OSs are available
+
+```
+
+
+Here are some typical uses
 
 ``` shell
     # show an OS ISO download URL for {os} {release} [edition]
-    quickget --show-iso-url fedora 38 Silverblue
+    quickget --url fedora 38 Silverblue
     # test if an OS ISO is available for {os} {release} [edition]
-    quickget --test-iso-url nixos 23.05 plasma5
+    quickget --check nixos unstable plasma5
     # open an OS distribution homepage in a browser
-    quickget --open-distro-homepage  ubuntu-mate
+    quickget --open-homepage  ubuntu-mate
     # Only download image file into current directory, without creating VM
-    quickget --download-iso elementary 7.1
+    quickget --download elementary 7.1
 ```
 
-The `--show-iso-url`, `--test-iso-url`, and `--download-iso` options are fully
+The `--url`, `--check`, and `--download` options are fully
 functional for all operating systems, including Windows and macOS.
 
+Further information is available from the project [wiki](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features)
+
 ### Other Operating Systems
 
 `quickget` also supports:
diff --git a/quickemu.1-09-othermanualguests.md b/quickemu.1-09-othermanualguests.md
@@ -1,4 +1,4 @@
-### Custom Linux guests
+### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests)
 
 Or you can download a Linux image and manually create a VM
 configuration.

diff --git a/quickemu.1-10-macOSguests.md b/quickemu.1-10-macOSguests.md
@@ -1,4 +1,4 @@
-## Creating macOS Guests 🍏
+## [Creating macOS Guests](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests) 🍏
 
 `quickget` automatically downloads a macOS recovery image and creates a
 virtual machine configuration.

diff --git a/quickemu.1-11-Windowsguests.md b/quickemu.1-11-Windowsguests.md
@@ -1,4 +1,4 @@
-## Creating Windows guests 🪟
+## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟
 
 `quickget` can download
 [**Windows 10**](https://www.microsoft.com/software-download/windows10) and

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: April 21, 2024
+date: April 22, 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: April 21, 2024
+date: April 22, 2024
 author: Martin Wimpress
 ---