diff --git a/README.md b/README.md index 6bf616d8e3e9eec01c7b79cb04fc897b4d42d064..feeb2a60e792d45c1e6f671ee7642dcf3de393b7 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,19 @@ A Karaoke player made to replace the old bash scripts on Sakura. ## Table of content -- [Building instructions](#building-the-player) -- [Preparing karaokes for lektor](#preparing-a-kara-for-lektor) -- [How to use lektor](#how-to-use-lektor) -- [Contributing](#contributing) -- [MPD compatibility](#mpd) +- [lektor mk7](#lektor-mk7) + - [Table of content](#table-of-content) + - [Building the player](#building-the-player) + - [Prerequisites](#prerequisites) + - [Building instructions](#building-instructions) + - [Preparing a kara for lektor](#preparing-a-kara-for-lektor) + - [How to use lektor](#how-to-use-lektor) + - [Launch instructions](#launch-instructions) + - [How to update the lektord database](#how-to-update-the-lektord-database) + - [How to send commands to lektor](#how-to-send-commands-to-lektor) + - [How to configure lektor](#how-to-configure-lektor) + - [Contributing](#contributing) + - [MPD](#mpd) ## Building the player @@ -28,12 +36,16 @@ A Karaoke player made to replace the old bash scripts on Sakura. 3.31.0 or newer for [generated columns](https://www.sqlite.org/gencol.html) support - a POSIX.1-2008 compatible system (for MS Windows, use something like WSL2) -For the module sdl2, you will need the folowing prerequisites: +For the module sdl2, you will need the following prerequisites: - the [mpv](https://mpv.io/) development library - the [sdl2](https://www.libsdl.org/) development library - the [sdl2-image](https://www.libsdl.org/projects/SDL_image/) development library +For the Qt module, you will need the following prerequisites: + +- the [qt] develipment library, QtCore, QtWidgets in at least version 5.15 + For the module repo, you will need the folowing prerequisites: - the [libcurl](https://github.com/curl/curl) developmemt library