diff --git a/README.md b/README.md index 07ded21089b38df75c04794ebfdc8d6b8d1e7eff..d2ad19dfcbd3d878a04e62fbd95a7cb8268ec9cf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # AURA Engine -This piece of Software is part of 'AURA - AUtomated RAdio'. +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 + * switches the soundserver at the correct time to a given source for a specific show * records what is broadcasted * streams to an icecast server * plays to lineout @@ -77,10 +77,7 @@ sudo apt install \ #### Python Packages ```bash -sudo pip3 install \ - Flask Flask-SQLAlchemy \ - mysqlclient redis simplejson \ - mutagen validators +sudo pip3 install -r requirements.txt ``` #### Grab the code @@ -91,7 +88,7 @@ git clone https://gitlab.servus.at/autoradio/engine #### Set up a database -##### Command line way +##### Command line way ```bash mysql -u root -p @@ -107,7 +104,7 @@ Log into your phpmyadmin or adminer with correct privileges, create a database a #### Files and Folders -* Create the audio folder defined in your aura.ini +* Create the audio folder defined in your engine.ini ```bash mkdir /var/audio @@ -116,7 +113,7 @@ cp {where you cloned the repo}/configuration/engine.ini /etc/aura/engine.ini edit engine.ini to your needs ``` -* Edit settings in aura.ini. Take your time for that. +* Edit settings in engine.ini. Take your time for that. #### aura.py @@ -137,7 +134,7 @@ Reference: http://savonet.sourceforge.net/doc-svn/reference.html ##### Python Reference: -https://docs.python.org/3.5/ +https://docs.python.org/3.5/ #### Interfaces @@ -185,11 +182,11 @@ Well, this is - at least for me - a hard one. I could not manage to find correct **If you experience 'hangs' or other artefacts on the output signal** * reduce the quality (especially, when hangs are on the stream) or * install the realtime kernel with - + ```bash apt install linux-image-rt-amd64 reboot ``` - + or * invest in better hardware