diff --git a/README.md b/README.md index 4182011..7be5a76 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # Move2Docker -MOVE-II decoder docker container +MOVE-II decoder docker container for all the architectures your heart desires - x86_64, armv7l, ... + +Based on https://github.com/MOVE-II/move2radio. + +This container uses no blobs to build, however some proprietary code is needed. The distributed docker images only contain binary assets, this is achieved using docker multi-stage builds. The proprietary code is currently hosted at the LRZ GitLab by the MOVE-II team, and an older private mirror exists at the CHRZ Git server. It is forbidden to redistribute the proprietary code without permission, however binary assets compiled from it may be redistributed. ## Usage -Use the scripts from the `scripts` directory to control the docker containers. \ No newline at end of file +Use the scripts from the `scripts` directory to control the docker containers. + +## Configuration +Configure the proprietary code server using the file `config/config.sh` (see or copy `config/config.sh.example*`), and place or link your private key for the server access (`ìd_rsa`) there as well. Note that this key should not be protected with a password. \ No newline at end of file diff --git a/config/README.md b/config/README.md deleted file mode 100644 index 22a268d..0000000 --- a/config/README.md +++ /dev/null @@ -1 +0,0 @@ -Configure the proprietary code server using the file `config.sh` (see or copy `config.sh.example`), and place or link your private key for the server access here (`ìd_rsa`). Note that this key should not be protected with a password. \ No newline at end of file diff --git a/config/config.sh.example-chrz b/config/config.sh.example-chrz new file mode 100644 index 0000000..6d0275d --- /dev/null +++ b/config/config.sh.example-chrz @@ -0,0 +1,4 @@ +export PROP_SERVER=git.chrz.de +export PROP_SERVER_USER=username +export PROP_DIR_SDR=sdr +export PROP_DIR_DECODER=sdr \ No newline at end of file diff --git a/config/config.sh.example b/config/config.sh.example-lrz similarity index 73% rename from config/config.sh.example rename to config/config.sh.example-lrz index f5725e5..f4d68ac 100644 --- a/config/config.sh.example +++ b/config/config.sh.example-lrz @@ -1,4 +1,4 @@ export PROP_SERVER=gitlab.lrz.de -export PROP_SERVER_USER=ga123xyz +export PROP_SERVER_USER=username export PROP_DIR_SDR=sdr export PROP_DIR_DECODER=mondbaron \ No newline at end of file