diff --git a/README.md b/README.md index 9690eb9afbac541e716a1ad58738b0b4437bebbe..cfe0e74b702f6719323011218e35dbfa7b499efd 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ The lektord and related binaries and source code are under the MIT license. Plea To visualize dependencies of the rust part of lektor, you can call the script [print-cargo-deps.bash](/utils/scripts/print-cargo-deps.bash) from the workspaces. You will also -need to have `dot` utility from the `graphviz` package to be installed for that script to work. +need to have dot utility from the graphviz package to be installed for that script to work. ### Building instructions @@ -91,16 +91,16 @@ appimagetool --comp xz --sign --sign-key $YOUR_SIGN_KEY Amadeus ### Launch instructions -To run lektor, you can simply run the binary like: `./lektord`. Be sure to place the -`liblektor_c.so` shared library **next** to the `lektord` binary before executing it. If lektord did -not exit normally. Lektor will use specialized software (hwdec set to yes), if you have an nvidia -card with optimus (in almose every laptop), please use `optirun` or `primusrun`. +To run lektor, you can simply run the binary. Be sure to place the liblektor_c.so shared library +*next* to the lektord binary before executing it. If lektord did not exit normally. Lektor will use +specialized software (hwdec set to yes), if you have an nvidia card with optimus (in almose every +laptop), please use optirun or primusrun. ### How to update the lektord database -To update the lektor database, you first need to launch `lektord`, then use the `lkt -Au` to update +To update the lektor database, you first need to launch lektord, then use the `lkt -Au` to update the database and import users' favorite lists as playlists. You can also perform the update action -from the `amadeus` client, in the search section. +from the amadeus client, in the search section. While connected to kurisu, you need to obtain a token, it can be achieved by visiting the page https://kurisu.iiens.net/api/download.php?token while being connected. You must copy this token in @@ -109,14 +109,14 @@ section. ### How to send commands to lektor -To send commands to lektor, you can use `lkt` or build your own by calling directly the REST API -with curl or other things. For graphical things, you can use `amadeus` which is a client written in +To send commands to lektor, you can use lkt or build your own by calling directly the REST API with +curl or other things. For graphical things, you can use amadeus which is a client written in [iced](https://iced.rs/). -The `lektord` daemon and the `amadeus` client implements the +The lektord daemon and the amadeus client implements the [MPRIS Specification](https://specifications.freedesktop.org/mpris-spec/latest/). As such you can use any MPRIS-able client to control them (playerctl, directly calling dbus things, etc.) By default -`lektord` enables MPRIS while `amadeus` doesn't, this behaviour can be changed in the config files. +lektord enables MPRIS while amadeus doesn't, this behaviour can be changed in the config files. ### How to configure lektor @@ -128,5 +128,5 @@ The default configuration file will be created on the first launch of the tool. configuration folder the lektord program will store its configuration in `lektord.toml`, lkt in `lkt.toml`, amadeus in `amadeus.toml`, etc. -For `amadeus`, you can edit its configuration file in the settings section. +For amadeus, you can edit its configuration file in the settings section. diff --git a/utils/scripts/docker/package_appimages.bash b/utils/scripts/docker/package_appimages.bash index 3fabeb467dc8f2f87a9a1c237cb8343be3185cd1..7defcd4a71a05b1e8976c24ce32ca054bad9ff3f 100755 --- a/utils/scripts/docker/package_appimages.bash +++ b/utils/scripts/docker/package_appimages.bash @@ -97,7 +97,7 @@ this_dir="\$(readlink -f "\$(dirname "\$0")")" source "\$HOOK" done } -exec "\$this_dir/usr/bin/${EXEC}" "$@" +exec "\$this_dir/usr/bin/${EXEC}" $@ EOF # Pack the AppImage