Skip to content

Commit

Permalink
Add index page
Browse files Browse the repository at this point in the history
  • Loading branch information
goldyfruit committed Sep 12, 2023
1 parent f396fd5 commit 64ca5b2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
15 changes: 15 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Getting started

Want to give Open Voice OS a try? Open Voice OS is open source software that runs where you want it to, whether it’s on your [own hardware](../about/why-use-ovos.md#multi-device-compatibility) or one of the dedicated [Mark 1](https://mycroft.ai/product/mycroft-mark-1/) or [Mark II](https://mycroft.ai/product/mark-ii/).

<div class="grid cards" markdown>

- :material-docker:{ .xl .middle } __Docker__

`arm64` :material-check-circle-outline:{ style="color: green" } `x86_64` :material-check-circle-outline:{ style="color: green" }

Use container engine such as [Docker](https://www.docker.com/) or [Podman](https://podman.io/) and their `composer` to run a ^^complete^^, ^^secure^^, ^^isolated^^ and ^^"easy to update"^^ instance of Open Voice OS!

[:octicons-arrow-right-24: Getting started with Docker](./docker/index.md)

</div>
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
site_name: Open Voice OS Docker Documentation
site_name: Open Voice OS Container Documentation
site_url: https://openvoiceos.github.io/ovos-docker/
site_author: Gaëtan Trellu
site_description: >-
Use Docker or Podman to deploy Open Voice OS components on x86 or ARM64.
Use Docker or Podman to deploy Open Voice OS components on x86 or ARM64 platforms.
repo_name: OpenVoiceOS/ovos-docker
repo_url: https://github.com/OpenVoiceOS/ovos-docker
edit_uri: edit/main/docs/
edit_uri: edit/documentation/docs/

copyright: |
2023 <a href="https://www.openvoiceos.org" target="_blank" rel="noopener">Open Voice OS</a>
Expand Down

0 comments on commit 64ca5b2

Please sign in to comment.