diff --git a/README.md b/README.md index 5f36768..64cad1f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,22 @@ mod-panel is a simple control panel to start MOD Host + UI and SDK services. ## Usage -Simply clone this repository recursively (either with `git clone --recursive` or `git submodule --init --update` afterwards), build and run it: +Simply clone this repository recursively + +```shell +git clone --recursive REPOSITORY_URL +``` + +or init submodules using + +```shell +git submodule init +git submodule update +``` + +in a cloned repository. + +Then build and run it: ```sh make @@ -17,15 +32,15 @@ make Afterwards simply click on "Start" for MOD Host + UI or SDK, and then its ">" button to open a browser on the predefined location. -If you have used [mod-plugin-builder](https://github.com/moddevices/mod-plugin-builder) before to build `x86_64` plugin binaries, the plugin path is adjusted automatically to it. -You can always override `LV2_PATH` environment variable to a custom location of your choosing. +If you have used [mod-plugin-builder](https://github.com/moddevices/mod-plugin-builder) before to build `x86_64` plugin binaries, the plugin path is adjusted automatically. +You can always override `LV2_PATH` environment variable to a custom location. ### Dependencies ALSA, JACK and LV2 (lilv) libraries are required, as well as PyQt5 for the UI. -Python's `virtualenv` and `pip` is used to get the required versions of python libraries, as they cannot be too new or too old. -(so Linux distribution packages are often not usable here) +Python's `virtualenv` and `pip` is used to get the required versions of Python libraries +(Linux distribution packages are often not supported versions). ## Notes