diff --git a/README.md b/README.md index 0fb73390d75f79acc998473f38f187a4ed6ce94e..5258599c7aec12d6ddccd4d20a9ac816b9bd34c0 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ 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.61 +- a [rust](https://www.rust-lang.org) compiler with version >= 1.65 - the [sqlite3](https://www.sqlite.org/) development library - a POSIX.1-2008 compatible system (for MS Windows, use something like WSL2) @@ -41,38 +41,24 @@ For the Qt module, you will need the following prerequisites: - the [Qt6](https://www.qt.io/) development library, QtCore, QtWidgets, QtOpenGL, QtOpenGLWidgets -For the module repo, you will need the folowing prerequisites: - -- the [libcurl](https://github.com/curl/curl) developmemt library - -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) -- the command line tool xxd, is distributed in the - [vim](https://www.archlinux.org/packages/extra/x86_64/vim/) and - [gvim](https://www.archlinux.org/packages/extra/x86_64/gvim/) packages - on archlinux, seems to be distributed in its own package on debian: - [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. +You will also 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. You will also need diesel -for all the database stuff, use the following command to install diesel cli with -the correct sqlite support on your system: +all the options to put in the `.clang-format` file. + +You will also need diesel for all the database stuff, use the following command +to install diesel cli with the correct sqlite support on your system. You may +also install depgraph if you want to visualize the dependency graphs. ```sh cargo install diesel_cli --no-default-features --features sqlite +cargo install cargo-depgraph ``` To visualize dependencies of the rust part of lektor, you can write the following commands from the root of each rust workspaces: ```sh -cargo install cargo-depgraph cargo depgraph --all-deps --dedup-transitive-deps | dot -Tpng > dependencies.png ```