Updated image links (#83)

* Updated image links Added refrence to ovos-installer * Updated to comments
OpenVoiceOS · Jan 21, 2024 · 0b17766 · 0b17766
1 parent 73167ea
commit 0b17766
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 16 deletions.
diff --git a/docs/030-qs_intro.md b/docs/030-qs_intro.md
@@ -18,21 +18,42 @@ If you want to build your own 32-bit image for OVOS, note that 32-bit operating
 
 ### Download an OVOS image
 
-OVOS provides a couple of different images specifically for the Raspberry Pi: a [headless image built on Raspberry Pi OS (RaspOVOS)](#rasberry-pi-os-latest-images) and an older/work-in-progress [full GUI image (Buildroot)](#buildroot-latest-image).
+OVOS provides a couple of different types of pre-built images made specifically for the RPi.
 
-#### Raspberry Pi OS Latest Images
+- Headless
+These images do not utilize the GUI functionality of OVOS and provide a similar experience to the original [picroft](https://github.com/MycroftAI/enclosure-picroft) software from [MycroftAI](https://github.com/MycroftAI).
 
-OVOS provides a "Headless" image that is similar to the original `picroft` software from `MycroftAI`. It runs without a screen, is built on top of Raspberry Pi OS, and works with a RPi3b/b+. It is often referred to as **RaspOVOS**.
+- GUI
+The GUI images allow you to interact with your assistant using a screen along with your voice.  There are even skills available specifically designed for use with the GUI.
 
-- [headless images](https://ovosimages.ziggyai.online/raspbian/development)
+#### Buildroot Images
 
-[Instructions on flashing the image can be found here](#flashing_an_image.md).
+[buildroot](https://github.com/OpenVoiceOS/ovos-buildroot) - An OS completely built from source so it is optimized for the Rpi.
+
+**Features**
+- A small set of skills so you can enjoy your assistant from the first boot.
+- Fully built from source packages.
+  - This allows the software to be optimized for the hardware being used.
+- Headless and GUI images
+- Compatible with RPi4/RPi3b *RPi3b headless only*
+- **New hardware is being added**
+
+- [OVOS Buildroot Images](https://drive.google.com/file/d/1PUtNXfZ5jMUlVAgyN-KXPdVdX6r51eBw/view?usp=share_link)
 
-#### Buildroot Latest Image
+#### RaspOVOS Images
 
-The most advanced and featureful is the Buildroot image. If you want the full GUI, this is currently your only choice. _Please note that this image is older and running on OVOS 0.0.6. A new Buildroot image is in development but not yet available._
+[raspOVOS](https://github.com/OpenVoiceOS/raspOVOS) - The full OVOS stack on top of the latest Raspberry Pi OS.
 
-- [RPi4-64](https://drive.google.com/file/d/1PUtNXfZ5jMUlVAgyN-KXPdVdX6r51eBw/view?usp=share_link)
+**Features**
+- A small set of skills so you can enjoy your assistant from the first boot.
+- Built on top of the latest [Raspberry Pi OS](https://www.raspberrypi.com/software/) providing a full operating system.
+- Head and GUI images
+- Compatible with RPi4/RPi3b *RPi3b headless only*
+- **New hardware coming soon**
+
+- [raspOVOS Images](https://ovosimages.ziggyai.online/raspbian/newest)
+  - These are **unstable** builds, and not always working.
+  - Backup images of previous builds are [located here](https://ovosimages.ziggyai.online/raspbian/development)
 
 [Instructions on flashing the image can be found here](#flashing_an_image.md).
 
@@ -46,14 +67,16 @@ For most users, the easiest way to get started with OVOS is to use Docker. Docke
 
 The new OVOS buildroot image (under construction) uses Podman to manage the OVOS services, allowing for easy setup and upgrades.
 
-[https://github.com/OpenVoiceOS/ovos-docker](https://github.com/OpenVoiceOS/ovos-docker)
+OVOS Docker provides [its own documentation](https://openvoiceos.github.io/ovos-docker/) with details on how to use and configure for your situation.
 
-The README at the link above explains how to set up OVOS on Docker for multiple different architectures and operating systems. New images are built nightly.
+[OVOS Docker Github page](https://github.com/OpenVoiceOS/ovos-docker)
 
 To install Docker, [please see the official documentation](https://docs.docker.com/engine/install/).
 
 ## Manual Install
 
+OVOS provides an [official installer](https://github.com/OpenVoiceOS/ovos-installer) which should allow you to easily install OVOS to a variety of operating systems including Windows and MacOS.  More information on using this tool can be found on the [ovos_installer](044-ovos_installer) page in these docs.
+
 For Debian-based Linux distros, [you can install OVOS manually via a shell script](https://github.com/OpenVoiceOS/raspbian-ovos/blob/dev/manual_user_install.sh). This is not recommended for most users, but may be useful for developers and advanced users.
 
 [OVOS also maintains an Ansible playbook for installing the assistant software](https://github.com/OpenVoiceOS/ovos-ansible). It currently supports Debian-based distros, but support for other distros is planned, and PRs are welcome.

diff --git a/docs/040-install_intro.md b/docs/040-install_intro.md
@@ -20,10 +20,25 @@ The easiest and fastest way to experience what OVOS has to offer is to use one o
 
 **NOTE** Images are currently only available for a RPi3b/b+/4.  More may be on the way.
 
-- [Buildroot-ovos](https://drive.google.com/drive/folders/113-zmx6ncoeLNsayseNxoaTlaAk1AfU2)
-  - The most complete and advanced image OVOS provides, complete with a default set of skills and a GUI.
-- [raspbian-ovos](https://ovosimages.ziggyai.online/raspbian/development)
-  - The newest image from the OVOS team.  This is a "headless" image (NO GUI), but comes with a preinstalled set of skills also.  This image will provide you with an experience similar to the origional [picroft](https://github.com/MycroftAI/enclosure-picroft)
+#### Features across all images
+
+- A small set of pre-installed skills so you may use your assistant right away
+- Out of the box support for the Mycroft Mark II.
+- Out of the box support for most USB microphones and speakers.
+- Out of the box support for ReSpeaker style HAT's.
+- More hardware support to come.
+
+- [OVOS - Buildroot Edition](https://drive.google.com/drive/folders/113-zmx6ncoeLNsayseNxoaTlaAk1AfU2)
+  - The most complete and advanced image OVOS provides.
+  - All packages are built from scratch, optimizing along the way.
+- [raspOVOS](https://ovosimages.ziggyai.online/raspbian/newest)
+  - raspOVOS provides the complete OVOS ecosystem on top of the official raspbian OS lite image.
+    - The "headless" image (NO GUI)
+      - Can be run on a RPi3b.
+      - This image will provide you with an experience similar to the original [picroft](https://github.com/MycroftAI/enclosure-picroft)
+    - The "GUI" image
+      - Similar to the "headless" image, but has a GUI and specific packages installed for convenience.
+      - Only runs on a RPi4, the RPi3 does not have enough power to run the GUI.
 
 [Get started with an image](030-qs_intro.md)
 
@@ -40,3 +55,10 @@ This is an advanced setup and requires access to a command shell and can take mo
 Docker images are also available and have been tested and working on Linux, Windows, and even Mac.
 
 [Get started with OVOS Docker](043-install_ovos_docker.md)
+
+### OVOS Installer
+
+This is the newest way users can install OVOS on their system.
+You can choose to install Docker containers, or install OVOS to a virtual environment.
+
+[Get started with OVOS Installer](044-ovos_installer.md)
diff --git a/docs/042-install_ovos_core.md b/docs/042-install_ovos_core.md
@@ -3,7 +3,7 @@ The OVOS ecosystem is very modular, depending on where you are running `ovos-cor
 
 By default `ovos-core` only installs the minimum components common to all services, for the purposes of this document we will assume you want a full install with a GUI.
 
-**NOTE** The GUI requires separate packages in addition to what is required by `ovos-core`.  The [GUI installation](044-install_gui.md) is covered in its own section.
+**NOTE** The GUI requires separate packages in addition to what is required by `ovos-core`.  The [GUI installation](048-install_gui.md) is covered in its own section.
 
 ## Host system
 OVOS requires some system dependencies, how to do this will depend on your distro.

diff --git a/docs/044-ovos_installer.md b/docs/044-ovos_installer.md
@@ -0,0 +1,15 @@
+# OVOS Installer
+
+[OVOS-Installer](https://github.com/OpenVoiceOS/ovos-installer) is the newest way to install OVOS and is probably the easiest way to install on an existing system.
+
+## Prerequisites
+
+You do need a few packages installed on your host system before starting.
+- `curl`
+- `git`
+- `sudo` and sudo access for your user
+After installing those packages, simply run a command and follow the on screen instructions.
+
+`sh -c "curl -s https://raw.githubusercontent.com/OpenVoiceOS/ovos-installer/main/installer.sh -o installer.sh && chmod +x installer.sh && sudo ./installer.sh && rm installer.sh"`
+
+More information on the OVOS Installer can be found on the [README](https://github.com/OpenVoiceOS/ovos-installer/blob/main/README.md) page in its Github repository.
diff --git a/docs/044-install_gui.md → docs/048-install_gui.md b/docs/044-install_gui.md → docs/048-install_gui.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -18,7 +18,8 @@ nav:
         - Installing an Image: 030-qs_intro.md
         - Install as a Library: 042-install_ovos_core.md
         - Install with Docker: 043-install_ovos_docker.md
-        - Install GUI: 044-install_gui.md
+        - OVOS Installer: 044-ovos_installer.md
+        - Install GUI: 048-install_gui.md
     - Starting OVOS:
         - Introduction: 050-starting_intro.md
         - Starting Modules: 051-starting_modules.md