edited README.md

This commit is contained in:
bisco 2020-05-17 11:59:33 +02:00
parent f47ed8cc36
commit 91f98fb66c
1 changed files with 20 additions and 1 deletions

View File

@ -1,3 +1,22 @@
# strummolo
Strummolo installs a gizmo for a mumble-based streaming radio
This script installs and configures a gizmo for a mumble-based radio
### what is this?
*strummolo* is a script made by nerds for nerds.
It should work flawlessly on Debian Buster systems, but considering that it installs packages, users and so on, you should install it into an isolated environment such a dedicated server (physical or virtual) or such an LXC container.
### how it works?
*strummolo* is a bash script, you can easily modify it to fit your needs.
You _have_ to modify the configuration files, otherwise it won't work.
Steps to deploy *strummolo*
1. clone the repository (or download the tarball and extract it)
2. run `./deploy.sh -i` and wait for the error :D
3. enjoy
### why this name?
The *strummolo* is a neapolitan name for the spinning top, an old game, which by now is almost no longer played. (source: Wikipedia)
It's origin is a crasis of terms *str*eaming and m*umble*: it should was been *strumble* but for a phonetic affinity it became *strummolo*.