Skip to content

Commit

Permalink
suggested changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mikejgray committed Feb 12, 2024
1 parent 34e3478 commit 20a70f8
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

[Mycroft](https://mycroft.ai) was a hackable, open source voice assistant by the now defunct MycroftAI. OpenVoiceOS continues that work and ovos-core (this repo) is the central component.

All Mycroft Skills and Plugins should work normally with OVOS-core. Other Mycroft-based assistants are also believed, but not guaranteed, to be compatible.
All Mycroft Skills and Plugins should work normally with OVOS-core, with the exception of Common Play and other media-related skills. Other Mycroft-based assistants are also believed, but not guaranteed, to be compatible.

The biggest difference between OVOS-core and Mycroft-core is that OVOS-core is fully modular. Furthermore, common
components have been repackaged as plugins. That means it isn't just a great assistant on its own, but also a pretty
Expand All @@ -24,18 +24,21 @@ small library!
- [Getting Involved](#getting-involved)
- [Links](#links)


## Installing OVOS

We strongly suggest you use the companion project [ovos-installer](https://github.com/OpenVoiceOS/ovos-installer) to install OVOS, several repositories are needed to get the full assistant running
If you have an existing system that you would like to install OVOS on, we strongly suggest the [ovos-installer](https://github.com/OpenVoiceOS/ovos-installer) to install OVOS and its dependencies. The full assistant requires several repositories and the installer makes it easy to install them all at once.

If you would like to install OVOS on a Raspberry Pi, we suggest using the [RaspOVOS](https://github.com/OpenVoiceOS/RaspOVOS) image. This image is based on Raspberry Pi OS and includes OVOS and its dependencies running in a "headless" mode (no GUI). It is designed and optimized for a Raspberry Pi 3B, so on a 4 or higher its performance is even better.

If you would like to install OVOS on embedded hardware, we suggest using [ovos-buildroot](https://github.com/OpenVoiceOS/ovos-buildroot). This is a buildroot configuration that can be used to build a custom Linux distribution for embedded hardware. It includes OVOS and its dependencies, and is designed to be as small and efficient as possible.

You can find detailed documentation over at the [community-docs](https://openvoiceos.github.io/community-docs) or [ovos-technical-manual](https://openvoiceos.github.io/ovos-technical-manual)

This repo can be installed standalone via `pip install ovos-core`
This repo can be installed standalone via `pip install ovos-core`, which will install the bare minimum components common to all services. This is useful for developers who want to build their own custom voice assistant. For more details, [please see the community docs](https://openvoiceos.github.io/community-docs/042-install_ovos_core/).

## Skills

OVOS is nothing without skills. There are a handful of default skills, but most need to be installed explicitly.
OVOS is nothing without skills. There are a handful of default skills, but [most need to be installed explicitly](https://openvoiceos.github.io/community-docs/080-ht_skills/). OVOS skills are all pip-installable, and can be found on [PyPI](https://pypi.org/) or by [browsing the OVOS organization on GitHub](https://github.com/orgs/OpenVoiceOS/repositories?language=&q=skill&sort=&type=all). Most classic Mycroft skills will also work on OVOS.

Please share your own interesting work!

Expand All @@ -51,11 +54,11 @@ Join the [Discussions](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions) f

## Credits

the OpenVoiceOS team thanks the following entities (in addition to MycroftAI) for making certain code and/or
The OpenVoiceOS team thanks the following entities (in addition to MycroftAI) for making certain code and/or
manpower resources available to us:

- NeonGecko
- KDE / Blue Systems
- [NeonGecko](https://neon.ai)
- [KDE](https://kde.org) / [Blue Systems](https://blue-systems.com/)

## Links

Expand Down

0 comments on commit 20a70f8

Please sign in to comment.