forked from MycroftAI/mycroft-core
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
48 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,76 @@ | ||
| [](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions) | ||
| [](LICENSE.md) | ||
| [](http://makeapullrequest.com) | ||
|  | ||
| [](https://codecov.io/gh/OpenVoiceOS/ovos-core) | ||
| [](http://makeapullrequest.com) | ||
| [](https://matrix.to/#/#OpenVoiceOS-general:matrix.org) | ||
| [](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions) | ||
|
|
||
| # OVOS-core | ||
| # 🗣️ OVOS-core | ||
|
|
||
| 🌟 **[OpenVoiceOS](https://openvoiceos.org/)** is an open-source platform for smart speakers and other voice-centric devices. | ||
|
|
||
| > `ovos-core` (this repo) is the central component. | ||
| --- | ||
|
|
||
| ## 🚀 Installing OVOS | ||
|
|
||
| [OpenVoiceOS](https://openvoiceos.org/) is an open source platform for smart speakers and other voice-centric devices. | ||
| 🛠️ If you have an existing system, we strongly recommend using the [ovos-installer](https://github.com/OpenVoiceOS/ovos-installer) to install OVOS and its dependencies. This tool simplifies installing everything in one go! | ||
|
|
||
| [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. | ||
| 📦 For Raspberry Pi users, the [RaspOVOS](https://github.com/OpenVoiceOS/RaspOVOS) image is a perfect choice. It runs in a "headless" mode (no GUI) and is optimized for Raspberry Pi 3B or higher. 💨 Enjoy even better performance on newer devices! | ||
|
|
||
| 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. | ||
| 🔧 For embedded systems, check out [ovos-buildroot](https://github.com/OpenVoiceOS/ovos-buildroot) – a custom Linux distribution for minimal and efficient setups. Stay tuned for updates! | ||
|
|
||
| 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 | ||
| small library! | ||
| 📚 More detailed documentation is available in the [ovos-technical-manual](https://openvoiceos.github.io/ovos-technical-manual). | ||
|
|
||
| ## Table of Contents | ||
| 🎯 Developers can install `ovos-core` standalone via: | ||
| ```bash | ||
| pip install ovos-core | ||
| ``` | ||
| This includes the core components, perfect for custom assistant development. | ||
|
|
||
| - [Installing OVOS](#installing-ovos) | ||
| - [Skills](#skills) | ||
| - [Getting Involved](#getting-involved) | ||
| - [Links](#links) | ||
| --- | ||
|
|
||
| ## Installing OVOS | ||
| ## 🎛️ Skills | ||
|
|
||
| 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. | ||
| 🌟 OVOS is powered by **skills**! | ||
| While some skills come pre-installed, most need to be installed explicitly. | ||
|
|
||
| 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. | ||
| 🔍 Browse OVOS-compatible skills on [PyPI](https://pypi.org/search/?q=ovos-skill-) or explore the [OVOS GitHub organization](https://github.com/orgs/OpenVoiceOS/repositories?language=&q=skill&sort=&type=all). | ||
|
|
||
| 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. | ||
| 🤔 Did you know most classic **Mycroft skills** also work on OVOS? | ||
|
|
||
| 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) | ||
| 🎉 Feel free to share your creative skills with the community! | ||
|
|
||
| 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 | ||
| ## 🤝 Getting Involved | ||
|
|
||
| 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. | ||
| 🌍 OVOS is **open source** and thrives on community contributions. Whether you're a coder, designer, or translator, there's a way to contribute! | ||
|
|
||
| Please share your own interesting work! | ||
| 📜 Read our [Contributing Guide](.github/CONTRIBUTING.md) to get started. | ||
|
|
||
| ## Getting Involved | ||
| 🌐 **Translate!** Help improve OVOS in your language through our [Translation Portal](https://gitlocalize.com/users/OpenVoiceOS). | ||
|
|
||
| This is an open source project. We would love your help. We have prepared a [contributing](.github/CONTRIBUTING.md) | ||
| guide to help you get started. | ||
| 🙋♂️ Have questions or need guidance? Say hi in the [OpenVoiceOS Chat](https://matrix.to/#/!XFpdtmgyCoPDxOMPpH:matrix.org?via=matrix.org), and a team member will be happy to mentor you. | ||
|
|
||
| The easiest way for anyone to contribute is to help with translations! You can help without any programming knowledge via the [translation portal](https://gitlocalize.com/users/OpenVoiceOS) | ||
| 💡 Join our [Discussions](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions) to ask questions, share ideas, and learn from the community! | ||
|
|
||
| If this is your first PR, or you're not sure where to get started, | ||
| say hi in [OpenVoiceOS Chat](https://matrix.to/#/!XFpdtmgyCoPDxOMPpH:matrix.org?via=matrix.org) and a team member would | ||
| be happy to mentor you. | ||
| Join the [Discussions](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions) for questions and answers. | ||
| --- | ||
|
|
||
| ## Credits | ||
| ## 🏆 Credits | ||
|
|
||
| The OpenVoiceOS team thanks the following entities (in addition to MycroftAI) for making certain code and/or | ||
| manpower resources available to us: | ||
| The OpenVoiceOS team extends gratitude to the following organizations for their support in our early days: | ||
| - **Mycroft** was a hackable, open-source voice assistant by the now-defunct MycroftAI. OpenVoiceOS continues that work | ||
| - [NeonGecko](https://neon.ai) | ||
| - [KDE](https://kde.org) / [Blue Systems](https://blue-systems.com) | ||
|
|
||
| - [NeonGecko](https://neon.ai) | ||
| - [KDE](https://kde.org) / [Blue Systems](https://blue-systems.com/) | ||
| --- | ||
|
|
||
| ## Links | ||
| ## 🔗 Links | ||
|
|
||
| * [Community Documentation](https://openvoiceos.github.io/community-docs) | ||
| * [ovos-technical-manual](https://openvoiceos.github.io/ovos-technical-manual) | ||
| * [Release Notes](https://github.com/OpenVoiceOS/ovos-core/releases) | ||
| * [OpenVoiceOS Chat](https://matrix.to/#/!XFpdtmgyCoPDxOMPpH:matrix.org?via=matrix.org) | ||
| * [OpenVoiceOS Website](https://openvoiceos.org) | ||
| * [Open Conversational AI Forums](https://community.openconversational.ai/) (previously mycroft forums) | ||
| - 📘 [Technical Manual](https://openvoiceos.github.io/ovos-technical-manual) | ||
| - 💬 [OpenVoiceOS Chat](https://matrix.to/#/!XFpdtmgyCoPDxOMPpH:matrix.org?via=matrix.org) | ||
| - 🌐 [Website](https://openvoiceos.org) | ||
| - 🛠️ [Release Notes](https://github.com/OpenVoiceOS/ovos-core/releases) | ||
| - 📣 [Open Conversational AI Forums](https://community.openconversational.ai/) (previously Mycroft forums) | ||
| ``` |