diff --git a/README.md b/README.md index e1369a212b31576204403797eef6df3a23daf66a..3e34f483104ce10041f12418a4e5a956bbe1afa1 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,17 @@ the requirements of community radio stations. <!-- TOC --> -- [Aura Engine](#aura-engine) - - [Functionality](#functionality) - - [Scheduler](#scheduler) - - [Versatile playlists](#versatile-playlists) - - [Default playlists](#default-playlists) - - [Heartbeat Monitoring](#heartbeat-monitoring) - - [Logging](#logging) - - [Getting started](#getting-started) - - [Using Docker](#using-docker) - - [Read more](#read-more) - - [About](#about) +1. [Aura Engine](#aura-engine) + 1. [Functionality](#functionality) + 1. [Scheduler](#scheduler) + 1. [Versatile playlists](#versatile-playlists) + 2. [Default playlists](#default-playlists) + 2. [Heartbeat Monitoring](#heartbeat-monitoring) + 3. [Logging](#logging) + 2. [Getting started](#getting-started) + 3. [Using Docker](#using-docker) + 4. [Read more](#read-more) + 5. [About](#about) <!-- /TOC --> @@ -33,7 +33,7 @@ In conjuction with other AURA components Engine provides several features: - **Autonomous playout** by caching the schedule information pulled from [Steering](https://gitlab.servus.at/aura/steering) in a local database. This allows Engine be keep running, independently from any network or service outages. This enables the application of (*High Availability* infrastructure scenarios)[https://gitlab.servus.at/aura/meta/-/blob/master/docs/installation-guide.md#high-availability]. - **Auto DJ with Silcence Detector** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core) - **Web Application for a Track Service** (see [AURA Player](https://gitlab.servus.at/aura/player)) -- **Web Application providing a Studio Clock** (see [Engine Clock](https://gitlab.servus.at/aura/engine-clock)) +- **Web Application providing a Studio Clock** (see [Dashboard Clock](https://gitlab.servus.at/aura/dashboard-clock)) - **Bulk and Timeslot Recorder** (*Not yet available*, this will be provided after v1.1 by a planned `engine-recorder` component) - **API** to query Track-Service, monthly reports and information for displaying the Studio Clock (see [Engine API](https://gitlab.servus.at/aura/engine-api)) @@ -116,5 +116,5 @@ AURA stands for Automated Radio and is a swiss army knife for community radio st | [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-steering.png" width="150" align="left" />](https://gitlab.servus.at/aura/steering) | [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-dashboard.png" width="150" align="left" />](https://gitlab.servus.at/aura/dashboard) | [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-tank.png" width="150" align="left" />](https://gitlab.servus.at/aura/tank) | [<img src="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-engine.png" width="150" align="left" />](https://gitlab.servus.at/aura/engine) | |---|---|---|---| -| [Steering](https://gitlab.servus.at/aura/steering) | [Dashboard](https://gitlab.servus.at/aura/dashboard) | [Tank](https://gitlab.servus.at/aura/tank) | [Engine](https://gitlab.servus.at/aura/engine)<br/>[Engine Core](https://gitlab.servus.at/aura/engine-core)<br/>[Engine API](https://gitlab.servus.at/aura/engine-api)<br/>[Engine Clock](https://gitlab.servus.at/aura/engine-clock) | +| [Steering](https://gitlab.servus.at/aura/steering) | [Dashboard](https://gitlab.servus.at/aura/dashboard)<br/>[Dashboard Clock](https://gitlab.servus.at/aura/dashboard-clock) | [Tank](https://gitlab.servus.at/aura/tank) | [Engine](https://gitlab.servus.at/aura/engine)<br/>[Engine Core](https://gitlab.servus.at/aura/engine-core)<br/>[Engine API](https://gitlab.servus.at/aura/engine-api) | diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 0f8815eb7fc5281f8d4ed4a47bbe984bc32ca41e..49f7ee5d14672d11f1d2497526c4675898595baf 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -4,15 +4,15 @@ This page gives insights on extending Aura Engine internals or through the API. <!-- TOC --> -- [Aura Engine Development Guide](#aura-engine-development-guide) - - [AURA Componentes](#aura-componentes) - - [Engine Components](#engine-components) - - [Running for Development](#running-for-development) - - [Testing](#testing) - - [API](#api) - - [Scheduler](#scheduler) - - [Docker](#docker) - - [Read more](#read-more) +1. [Aura Engine Development Guide](#aura-engine-development-guide) + 1. [AURA Componentes](#aura-componentes) + 2. [Engine Components](#engine-components) + 3. [Running for Development](#running-for-development) + 4. [Testing](#testing) + 5. [API](#api) + 6. [Scheduler](#scheduler) + 7. [Docker](#docker) + 8. [Read more](#read-more) <!-- /TOC --> @@ -55,7 +55,7 @@ Ensure you have following other projects up and running: - tank - dashboard - engine-api -- engine-clock (optional) +- dashboard-clock (optional) The following steps espect you having done the bases configuration and set up a database as outlined in the [Native Installation](https://gitlab.servus.at/aura/engine/-/blob/master/docs/bare-metal-installation.md) document.