diff --git a/README.md b/README.md index e69de29..e088817 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,32 @@ +# rvz-convert + +--- + +## Building + +Use the provided Makefile to build the project. Make sure to pass in multithreading parameters, as Dolphin is a large project with many submodules of its own. +e.g. + +``` +make -j$(nproc) +sudo make install +``` + + + +### Dependencies: + +- Qt6 Base +- Qt6 SVG +- Qt6 qtbase private libraries +- Working compiler toolchain (build-essential) +- GNU Make +- CMake + +### Building for Windows + +#### Dependencies: + +- WSL +- mingw64 Qt components (above) +- \ No newline at end of file