diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..347cfd4b0b8ecf49c2889bbc3e40922e153ab537 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,54 @@ +# AURA Engine + +This piece of Software is part of 'AURA - AUtomated RAdio'. + +AURA Engine does: + * requesting the programme from an external Source + * switches the soundserver at the correct time to a given source for a specific show + * records what is broadcasted + +## Installation + +### Software + +#### Operating System + +Any sound supporting linux system should work. It is tested and coded on a **debian stretch** + +#### Packages + +On a debian machine: + +```bash +sudo apt install python3 python3-pip \ + liquidsoap liquidsoap-plugin-alsa liquidsoap-plugin-ao liquidsoap-plugin-faad \ + liquidsoap-plugin-flac liquidsoap-plugin-icecast liquidsoap-plugin-lame \ + liquidsoap-plugin-mad liquidsoap-plugin-ogg liquidsoap-plugin-pulseaudio \ + liquidsoap-plugin-samplerate liquidsoap-plugin-taglib liquidsoap-plugin-voaacenc \ + liquidsoap-plugin-vorbis +``` + +#### Python Packages + +``` +sudo pip3 install Flask Flask-Babel flask-babel-utclocal-utils \ + flask-mongoengine Flask-RESTful Flask-SQLAlchemy Flask-WTF \ + mysqlclient redis simplejson +``` + +#### aura.py + +It is the server which is connected to the external programme source, to liquidsoap and is listening for redis pubsub messages. + +#### Guru + +The commandline tool for interacting with the server. + +#### Liquidsoap + +The heart of AURA Engine. It uses the built in mixer, to switch between different sources. A source can be a stream, the filesystem or linein + +### Hardware + +AURA Engine ist tested with an ASUS Xonar DGX. It should work with every by ALSA supported soundcard. PulseAudio support is planned. +