Skip to content

docs: rewrite README in Simplified Technical English #120

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.

Sign up for GitHub

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

Draft
JarbasAl wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

docs: rewrite README in Simplified Technical English #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 18 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@

[![Open Voice OS logo](https://raw.githubusercontent.com/OpenVoiceOS/ovos-docker/dev/docs/assets/logo.png)](https://openvoiceos.org/)

This repo holds the Dockerfiles and Buildx Bake configuration for the container images of [Open Voice OS](https://openvoiceos.org/), an open-source voice assistant platform. The images cover the core runtime, its services, GUIs, and default skills. Docker Buildx Bake builds and publishes the images.

## Documentation

Please follow the dedicated [documentation](https://openvoiceos.github.io/ovos-docker/).
Follow the dedicated [documentation](https://openvoiceos.github.io/ovos-docker/) for compose files, audio setup, GUI setup, and device mapping.

## What this repo builds

Expand All @@ -24,18 +26,20 @@ Please follow the dedicated [documentation](https://openvoiceos.github.io/ovos-d

## Run images

These images run on Docker or Podman. For compose files, audio/GUI setup, and device
mapping examples, follow the documentation.
These images run on Docker or Podman.

- Docker: `docker pull docker.io/smartgic/ovos-core:alpha`
- Podman: `podman pull docker.io/smartgic/ovos-core:alpha`

For compose files, audio/GUI setup, and device mapping examples, follow the
documentation.

## Build requirements

- Docker with Buildx (BuildKit) available for builds
- Podman works for running images, but builds use Docker Buildx Bake
- Network access to pull base images and dependencies
- Multi-arch builds may require binfmt/qemu; `scripts/bake.sh` can install it via
- Multi-arch builds may need binfmt/qemu. `scripts/bake.sh` can install it with
`tonistiigi/binfmt` (set `ENSURE_BINFMT=true` or use `--ensure-binfmt`)

## Build images
Expand Down Expand Up @@ -76,8 +80,18 @@ Examples:
- `REGISTRY=docker.io/smartgic TAG=alpha CHANNEL=alpha ./scripts/bake.sh`
- `TAG=stable CHANNEL=stable ./scripts/bake.sh -T services`

## Related projects

- [OpenVoiceOS/ovos-core](https://github.com/OpenVoiceOS/ovos-core): the core runtime this repo packages
- [OpenVoiceOS/ovos-docker-stt](https://github.com/OpenVoiceOS/ovos-docker-stt): speech-to-text container images
- [OpenVoiceOS/ovos-docker-tts](https://github.com/OpenVoiceOS/ovos-docker-tts): text-to-speech container images

## Support

- [Matrix channel](https://matrix.to/#/#openvoiceos:matrix.org)
- [Contribute to Open Voice OS](https://openvoiceos.github.io/community-docs/contributing/)
- [Report bugs related to these Docker images](https://github.com/OpenVoiceOS/ovos-docker/issues)

## License

This repo is under the [Apache License 2.0](LICENSE).