Update README for submodule structure
This commit is contained in:
43
README.md
43
README.md
@@ -2,14 +2,24 @@
|
||||
|
||||
Control your PC's media playback from Home Assistant.
|
||||
|
||||
This monorepo contains two separate components designed to be split into independent repositories:
|
||||
This repository contains two independent components as git submodules:
|
||||
|
||||
## Components
|
||||
|
||||
| Component | Description | Future Repository |
|
||||
|-----------|-------------|-------------------|
|
||||
| [Media Server](media-server/) | REST API server for your PC | `media-server` |
|
||||
| [HAOS Integration](haos-integration/) | HACS-ready Home Assistant integration | `haos-remote-media-player` |
|
||||
| Submodule | Description | Repository |
|
||||
|-----------|-------------|------------|
|
||||
| [media-server](media-server/) | REST API server for your PC | [media-player.git](https://git.dolgolyov-family.by/alexei.dolgolyov/media-player) |
|
||||
| [haos-integration](haos-integration/) | HACS-ready Home Assistant integration | [haos-hacs-emby-media-player.git](https://git.dolgolyov-family.by/alexei.dolgolyov/haos-hacs-emby-media-player) |
|
||||
|
||||
## Cloning
|
||||
|
||||
```bash
|
||||
# Clone with submodules
|
||||
git clone --recurse-submodules https://git.dolgolyov-family.by/alexei.dolgolyov/media-player-mixed.git
|
||||
|
||||
# Or if already cloned, initialize submodules
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -61,29 +71,6 @@ Copy `haos-integration/custom_components/remote_media_player/` to your HA config
|
||||
|
||||
See [HAOS Integration README](haos-integration/README.md) for detailed instructions.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
/
|
||||
├── media-server/ # Standalone Media Server
|
||||
│ ├── README.md # Server documentation
|
||||
│ ├── requirements.txt # Python dependencies
|
||||
│ ├── config.example.yaml # Example configuration
|
||||
│ └── media_server/ # Python package
|
||||
│ ├── main.py # Entry point
|
||||
│ ├── routes/ # API endpoints
|
||||
│ ├── services/ # Platform media controllers
|
||||
│ └── service/ # Service installers
|
||||
│
|
||||
├── haos-integration/ # HACS-ready HA Integration
|
||||
│ ├── README.md # Integration documentation
|
||||
│ ├── hacs.json # HACS configuration
|
||||
│ └── custom_components/
|
||||
│ └── remote_media_player/ # Integration code
|
||||
│
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Reference in New Issue
Block a user