Update README removing colon signs section headers (#265)

Update README to remove the colon sign from all section headers to make formatting consistant with other projects from the Open Home Foundation.
This commit is contained in:
Hedda authored and GitHub committed 2026-03-26 16:56:44 +01:00
1 parent 412035e6b2
commit 0dce320db2
1 file changed
+15 -16
+15 -16
View File
@@ -12,7 +12,7 @@ Because it runs on a full Linux system and offers access significantly more loca
[![A project from the Open Home Foundation](https://www.openhomefoundation.org/badges/ohf-project.png)](https://www.openhomefoundation.org/)
## Features:
## Features
- Works with [Home Assistant](https://www.home-assistant.io/integrations/esphome/) using the [ESPHome](https://esphome.io/) protocol/API (via [aioesphomeapi](https://github.com/esphome/aioesphomeapi))
- Feature local on-device wake word detection using integrated [OpenWakeWord](https://github.com/dscripka/openWakeWord) or [MicroWakeWord](https://github.com/kahrendt/microWakeWord)
@@ -24,10 +24,9 @@ Because it runs on a full Linux system and offers access significantly more loca
- Prebuild docker image available on [GitHub Container Registry](https://github.com/OHF-Voice/linux-voice-assistant/pkgs/container/linux-voice-assistant)
- Prebuild Raspberry Pi image
## Usage
## Usage:
### Hardware:
### Hardware
A more extensive list for possible compatible hardware can be found in the [PiCompose documentation](https://github.com/florian-asche/PiCompose) but basically any microphone that works with [PipeWire (multimedia framework for Linux)](https://pipewire.org/) can in theory be used for voice input with the prebuild image from there, you should however preferably use a far-field microphone-array solution if want better result.
@@ -39,15 +38,15 @@ As for the minimum required compute performance on these satellites the target r
But you can also install LVA on AMD64 devices, for example on your Linux desktop computer.
### Software:
### Software
#### Installation:
#### Installation
For Raspberry Pi users, we provide a prebuild image that can be flashed to a SD card. See [PiCompose](https://github.com/florian-asche/PiCompose).
For all other users we have different installation methods available (Docker, systemd), each with its own dedicated instructions. See [Linux-Voice-Assistant - Installation](docs/install.md).
#### Parameter overview:
#### Parameter overview
💡 **Note:** There is a [environment variable](docs/install_application.md#environment-variables-reference) for each parameter if you use docker or systemd based setup.
@@ -80,7 +79,7 @@ usage: __main__.py [-h] [--name NAME] [--audio-input-device AUDIO_INPUT_DEVICE]
| `--enable-thinking-sound` | Enable thinking sound on startup | False |
| `--debug` | Print DEBUG messages to console | False |
## Build Information:
## Build Information
Image builds can be tracked in this repository's `Actions` tab, and utilize [artifact attestation](https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds) to certify provenance.
@@ -92,9 +91,9 @@ The Docker images are built using GitHub Actions, which provides:
The documentation for the build process can be found in the [GitHub Actions Workflows](.github/workflow.md) file.
## Development:
## Development
### Code Quality Checks:
### Code Quality Checks
The project uses the following tools to ensure code quality:
- **Black**: Code formatting (88 characters per line, PEP 8 compliant)
@@ -103,7 +102,7 @@ The project uses the following tools to ensure code quality:
- **pylint**: Code quality checks
- **mypy**: Static type analysis
### Setup:
### Setup
To use the development tools (linting, testing, etc.), you need to install the required dependencies:
@@ -112,14 +111,14 @@ To use the development tools (linting, testing, etc.), you need to install the r
source .venv/bin/activate
```
### Linting Commands:
### Linting Commands
#### Run all linting checks:
#### Run all linting checks
``` sh
./script/lint...
```
#### Individual linting commands (with auto-fix support):
#### Individual linting commands (with auto-fix support)
| Script | Description | Auto-fix Available? |
|--------|-------------|---------------------|
@@ -129,7 +128,7 @@ source .venv/bin/activate
| `./script/lint_mypy` | Runs static type analysis with mypy | No |
| `./script/lint_pylint` | Runs code quality checks with pylint | Yes, use `--auto` flag |
#### Examples:
#### Examples
Run a specific lint check:
``` sh
@@ -142,7 +141,7 @@ Auto-fix formatting issues (Black + isort):
./script/lint_isort --auto
```
### Testing:
### Testing
Run the test suite:
``` sh