Skip to content

minor changes in README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

minor changes in README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this REPOSITORY_URL get autoreplaced on render? otherwise it should be the URL of this repo, so users can copy&paste directly.

```

or init submodules using

```shell
git submodule init
git submodule update
```

in a cloned repository.

Then build and run it:

```sh
make
Expand All @@ -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

Expand Down