Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JarbasAl authored Nov 7, 2024
1 parent d15adcc commit 81ff0a9
Showing 1 changed file with 29 additions and 27 deletions.
56 changes: 29 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ OVOS is a **modular** system, meaning that you don’t have to install all of it

- [Distros](#distros)
- [Release Channels](#release-channels)
- [Installation Commands for Each Channel](#installation-commands-for-each-channel)
- [OVOS from Scratch](#ovos-from-scratch)
- [What are OVOS Extras?](#what-are-ovos-extras)
- [Installation Commands for Each Channel](#installation-commands-for-each-channel)
- [Summary](#summary)

### Distros
Expand Down Expand Up @@ -43,6 +43,34 @@ These channels are managed via the [constraints files](https://pip.pypa.io/en/st
- The **alpha** channel includes the latest experimental features that are **still in development**. These are not recommended for production use.
- **Installation**: Use the `--pre` flag to install alpha releases.



### Installation Commands for Each Channel

#### Stable Release Installation

To install the stable release with the desired extras, use:

```bash
pip install ovos-core[mycroft] -c constraints-stable.txt
```

#### Testing Release Installation

To install the testing release with the desired extras, use:

```bash
pip install ovos-core[mycroft] -c constraints-testing.txt
```

#### Alpha Release Installation

To install the latest alpha release with the desired extras, use:

```bash
pip install ovos-core[mycroft] --pre
```

### OVOS from scratch

Instead of using distros you can costumize OVOS by manually installing only select services relevant to your use case
Expand Down Expand Up @@ -88,32 +116,6 @@ pip install ovos-core[mycroft,plugins,skills-essential]
This flexibility allows you to tailor the installation to your requirements, without unnecessary components.


### Installation Commands for Each Channel

#### Stable Release Installation

To install the stable release with the desired extras, use:

```bash
pip install ovos-core[mycroft] -c constraints-stable.txt
```

#### Testing Release Installation

To install the testing release with the desired extras, use:

```bash
pip install ovos-core[mycroft] -c constraints-testing.txt
```

#### Alpha Release Installation

To install the latest alpha release with the desired extras, use:

```bash
pip install ovos-core[mycroft] --pre
```

### Summary

- **OVOS is modular**, and you can choose which components (extras) to install based on your needs.
Expand Down

0 comments on commit 81ff0a9

Please sign in to comment.