diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 0000000..114c707 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,33 @@ +# Quickstart + +A nice, simple and intuitive way to install Open Voice OS and/or HiveMind using Bash, Whiptail (Newt) and Ansible. + +`curl`, `git` and `sudo` packages must be installed before running the installer. + +```shell +sh -c "curl -s https://raw.githubusercontent.com/OpenVoiceOS/ovos-installer/main/installer.sh -o installer.sh && chmod +x installer.sh && sudo ./installer.sh" +``` + +Then follow the instructions display on screen. + +## Automated install + +The installer supports a non-interactive *(automated)* process of installation by using a scenario file, this file must be created under the `~/.config/ovos-installer/` directory and should be named `scenario.yaml`. + +Here is an example of a scenario to install Open Voice OS within Docker containers on a Raspberry Pi 4B with default skills and GUI support. + +```shell +mkdir -p ~/.config/ovos-installer +cat < ~/.config/ovos-installer/scenario.yaml +--- +uninstall: false +method: containers +channel: development +profile: ovos +features: + skills: true + gui: true +rapsberry_pi_tuning: true +share_telemetry: true +EOF +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 127c616..26f347d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -155,6 +155,7 @@ nav: - Glossary: - Terms: about/glossary/terms.md - Components: about/glossary/components.md + - Quickstart: quickstart.md - Getting started: - Run OVOS within containers: - Docker or Podman: getting-started/docker/index.md