Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #411

Merged
merged 2 commits into from
Feb 14, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 22 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,49 +9,34 @@

[OpenVoiceOS](https://openvoiceos.org/) is an open source platform for smart speakers and other voice-centric devices.

[Mycroft](https://mycroft.ai) is a hackable, open source voice assistant by MycroftAI. OVOS-core is a
backwards-compatible descendant of [Mycroft-core](https://github.com/MycroftAI/mycroft-core), the central component of
Mycroft. It contains extensions and features not present upstream. All Mycroft Skills and Plugins should work normally
with OVOS-core. Other Mycroft-based assistants are also believed, but not guaranteed, to be compatible.
[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.
mikejgray marked this conversation as resolved.
Show resolved Hide resolved

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!

Furthermore, it offers a number of cli bindings. The old Mycroft shell scripts still exist, and still work, but that
stuff is now built into the Python program (docs to follow in the form of `--help`, because it's a lot.)

---

**Installing OVOS-core** (NOTE: at this early stage, required system libs are presumed, and your distribution might be a
question mark.)

We suggest you do this in a virtualenv:

`pip install ovos-core[mycroft]`

---

As always, the OpenVoiceOS team thanks the following entities (in addition to MycroftAI) for making certain code and/or
manpower resources available to us which may not have been compatible with our practices before:

- NeonGecko
- KDE
- Blue Systems

## Table of Contents

- [Running Mycroft](#running-mycroft)
- [Installing OVOS](#installing-ovos)
- [Skills](#skills)
- [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
mikejgray marked this conversation as resolved.
Show resolved Hide resolved

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`
mikejgray marked this conversation as resolved.
Show resolved Hide resolved

## Skills

Mycroft is nothing without skills. There are a handful of default skills, but most need to be installed explicitly.
See the [Skill Repo](https://github.com/MycroftAI/mycroft-skills#welcome) to discover skills made by others.
OVOS is nothing without skills. There are a handful of default skills, but most need to be installed explicitly.
mikejgray marked this conversation as resolved.
Show resolved Hide resolved

Please share your own interesting work!

## Getting Involved
Expand All @@ -64,15 +49,19 @@ say hi in [OpenVoiceOS Chat](https://matrix.to/#/!XFpdtmgyCoPDxOMPpH:matrix.org?
be happy to mentor you.
Join the [Discussions](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions) for questions and answers.

## Credits

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
mikejgray marked this conversation as resolved.
Show resolved Hide resolved

## 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)
* [Mycroft Documentation](https://docs.mycroft.ai)
* [Mycroft API Docs](https://mycroft-core.readthedocs.io/en/master/)
* [OpenVoiceOS Chat](https://matrix.to/#/!XFpdtmgyCoPDxOMPpH:matrix.org?via=matrix.org)
* [OpenVoiceOS Website](https://openvoiceos.com/)
* [Mycroft Chat](https://chat.mycroft.ai)
* [Mycroft Forum](https://community.mycroft.ai)
* [Mycroft Blog](https://mycroft.ai/blog)
* [Open Conversational AI Forums](https://community.openconversational.ai/) (previously mycroft forums)
Loading