diff --git a/README.md b/README.md index 7f7fd794e71f5341001dfd304cc4e4ef688d6c13..77dd649e98472cec38d9983f3a108b40580fad9d 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,15 @@ A Karaoke player made to replace the old bash scripts on Sakura. - [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) + - [Misc](#misc) + - [Contributing](#contributing) + - [Licenses](#licenses) + - [MPD](#mpd) ## Building the player @@ -30,16 +31,15 @@ A Karaoke player made to replace the old bash scripts on Sakura. - [cmake](https://cmake.org/) with at least the version 3.17 - a C compiler with C11 support - a C++ compiler with C++20 support (for the Qt6 module) -- a [rust](https://www.rust-lang.org) compiler with version >= 1.51 -- the [sqlite3](https://www.sqlite.org/) development library, version - 3.31.0 or newer for [generated columns](https://www.sqlite.org/gencol.html) support +- a [rust](https://www.rust-lang.org) compiler with version >= 1.61 +- the [sqlite3](https://www.sqlite.org/) development library - a POSIX.1-2008 compatible system (for MS Windows, use something like WSL2) For the Qt module, you will need the following prerequisites: - the [mpv](https://mpv.io/) development library -- the [Qt](https://www.qt.io/) develipment library, QtCore, QtWidgets, QtOpenGL, - QtOpenGLWidgets in at least version 6 +- the [Qt6](https://www.qt.io/) development library, QtCore, QtWidgets, + QtOpenGL, QtOpenGLWidgets For the module repo, you will need the folowing prerequisites: @@ -90,17 +90,9 @@ generate the config file again. If you are using special modules or are compiling lektor without static modules, you may set their **absolute path** inside the lektor's config file. -> **Important note**: Upgrading the config or the database scheme automatically -is not supported yet. If you are experiencing weird things with lektord, please -try first to delete the database and config and regenerate them. There are -currently no way of doing a backup of playlists and stickers with lektor, this -is WIP. - -## Preparing a kara for lektor - -The ideal way of populating lektor is using *Kurisu*. The `update` is here for -that. To import the favorites and playlists from *Kurisu*, use the `import` -command. +> **Important note**: Upgrading the database from version 2.4 to version 3 is +> not possible. You need to delete the database and re-dl all the karas from +> kurisu. ## How to use lektor @@ -149,16 +141,18 @@ config file is found, lektord will try to create the Be aware that if the home directory or the `XDG_CONFIG_HOME` are too long they will be ignored and truncated. You may then get uncomprehensible errors. -## Contributing +## Misc + +### Contributing Please, refer to the [CONTRIBUTING](CONTRIBUTING.md) file. -## Licenses +### Licenses The lektord and related binaries and source code are under the ISC license. The amadeus and related binaries abd siyrce code are under the MIT license. -## MPD +### MPD Lektor is almost MPD compatible, at least it uses the same protocol, which can be consulted [here](https://mpd.readthedocs.io/en/stable/protocol.html). The