Skip to content
Extraits de code Groupes Projets
Vérifiée Valider 8d5b64a9 rédigé par Kubat's avatar Kubat
Parcourir les fichiers

DOC: Update README

parent d5f8e169
Aucune branche associée trouvée
Aucune étiquette associée trouvée
1 requête de fusion!174Add batched add for IDs
......@@ -42,8 +42,8 @@ To build Klkt, you will need:
- qmake and Qt5 developpement libraries (Qt5Core Qt5Gui Qt5Network Qt5Widgets)
- don't forget the qt5dxcb-plugin (xcb plugin for qt5) when compiling
You will also need the following executables, with their path setted in
the configuration file:
You will also need the following executables, with their path setted in the
configuration file:
- mkvpropedit from [mkvtoolnix](https://gitlab.com/mbunkus/mkvtoolnix)
- the bourn shell again: [bash](https://git.savannah.gnu.org/cgit/bash.git)
......@@ -54,10 +54,10 @@ the configuration file:
[xxd](https://packages.debian.org/sid/xxd)
If you are developping for lektor, you will need the
[clang-format](https://releases.llvm.org/download.html) command line
utility, for a beautifull and uniform C++ code style.
[Here](https://clang.llvm.org/docs/ClangFormatStyleOptions.html) is the
list of all the options to put in the `.clang-format` file.
[clang-format](https://releases.llvm.org/download.html) command line utility,
for a beautifull and uniform C++ code style.
[Here](https://clang.llvm.org/docs/ClangFormatStyleOptions.html) is the list of
all the options to put in the `.clang-format` file.
### Building instructions
......@@ -69,66 +69,64 @@ cmake -Bbuild \
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_BUILD_TYPE=Debug # The debug stuff
```
Note that the last option is here to generate the
`compile_commands.json`, you should copy it at the root of the project.
Note that the last option is here to generate the `compile_commands.json`, you
should copy it at the root of the project.
The sqlite database and the config file will be created automatically if
needed, i.e. on the first run. If you are upgrading lektor, the config
might not be correct. You can delete the config file or use the `lkt
admin config` to generate the config file again.
The sqlite database and the config file will be created automatically if needed,
i.e. on the first run. If you are upgrading lektor, the config might not be
correct. You can delete the config file or use the `lkt admin config` to
generate the config file again.
> **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.
> **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.
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.
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.
## 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.
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.
## How to use lektor
### Launch instructions
To run lektor, you can simply run the binary like: `./lektord`. If
lektord did not exited normally (i.e. without the `lkt adm kill`
command), the database will still store the fact that lektord is
running. To by-pass it, you will need to launch lektord with the `-F`
(forced) option, like `lektord -F`.
To run lektor, you can simply run the binary like: `./lektord`. If lektord did
not exited normally (i.e. without the `lkt adm kill` command), the database will
still store the fact that lektord is running. To by-pass it, you will need to
launch lektord with the `-F` (forced) option, like `lektord -F`.
It is not recommended to launch always lektord with the `-F` option,
because that way you could launch multiple instances of the lektod
daemon, which could results in undefined behaviours.
It is not recommended to launch always lektord with the `-F` option, because
that way you could launch multiple instances of the lektod daemon, which could
results in undefined behaviours.
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`: `optirun ./lektord`
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`:
`optirun ./lektord`
### How to update the lektord database
To update the lektor database, you first need to launch `lektord`, then
use the `lkt adm update` to update the database and `lkt adm import` to
import users' favorite lists as playlists.
To update the lektor database, you first need to launch `lektord`, then use the
`lkt adm update` to update the database and `lkt adm import` to import users'
favorite lists as playlists.
### How to send commands to lektor
Lektor is compatible with mpd, which means that you can use any client
(only mpc is tested) to interact with lektor. Some functions are not
*really* compatible (somme work to be done) because mpc *really* makes
some assumptions. The ideal way is to use `lkt`.
Lektor is compatible with mpd, which means that you can use any client (only mpc
is tested) to interact with lektor. Some functions are not *really* compatible
(somme work to be done) because mpc *really* makes some assumptions. The ideal
way is to use `lkt`.
### How to configure lektor
Lektor configuration is done with an INI file. Modules' configuration is
also done by the same INI file using diferent sections. Lektor searches
for the configuration file in that order:
Lektor configuration is done with an INI file. Modules' configuration is also
done by the same INI file using diferent sections. Lektor searches for the
configuration file in that order:
1. `$PWD/lektor.ini`
2. if `XDG_CONFIG_HOME` defined? `$XDG_CONFIG_HOME/lektor/lektor.ini` :
......@@ -137,13 +135,12 @@ for the configuration file in that order:
4. `/usr/local/etc/lektor.ini`
5. `/etc/lektor.ini`
To get the default config file, you can use the `lkt adm conf` command.
If no config file is found, lektord will try to create the
To get the default config file, you can use the `lkt adm conf` command. If no
config file is found, lektord will try to create the
`$HOME/.config/lektor/lektor.ini` config file with the default content.
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.
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
......@@ -151,8 +148,7 @@ Please, refer to the [CONTRIBUTING](CONTRIBUTING.md) file.
## MPD
Lektor is almost MPD compatible, at least it uses the same protocol,
which can be consulted
[here](https://www.musicpd.org/doc/html/protocol.html#). The full
Lektor is almost MPD compatible, at least it uses the same protocol, which can
be consulted [here](https://www.musicpd.org/doc/html/protocol.html#). The full
support for MPD clients (like mpc and ncmpc) is still WIP. For the MPD
compatibility list, see the [CONTRIBUTING](CONTRIBUTING.md) file.
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Veuillez vous inscrire ou vous pour commenter