From 972431f210a73993880d6728199c22e5008ab56b Mon Sep 17 00:00:00 2001 From: Louie S Date: Thu, 4 Apr 2024 19:06:49 -0400 Subject: Add Linux build instructions to README --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 42 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f3f4832..b083558 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,54 @@ A QT application for managing grouped tasks (or "entries"). Originally written u ### Build Prerequisites -On Debian (Qt5): +On Debian/Debian-based (Qt5): ``` # apt install cmake git g++ libqt5core5a libqt5gui5 libqt5sql5 libqt5sql5-sqlite libqt5svg5 libqt5widgets5 qtbase5-dev qttools5-dev ``` -On Debian (Qt6): +On Debian/Debian-based (Qt6): ``` # apt install cmake git g++ libqt6core6 libqt6gui6 libqt6sql6 libqt6sql6-sqlite libqt6svg6 libqt6uitools6 libqt6widgets6 qt6-base-dev qt6-tools-dev ``` + +On Fedora (Qt5): + +``` +# dnf install cmake gcc-c++ qt5-qtbase-devel qt5-qttools-static qt5-qtsvg-devel +``` + +On Fedora (Qt6): + +``` +# dnf install cmake gcc-c++ qt6-qtbase-devel qt6-qttools-devel qt6-qtsvg-devel +``` + +### Build Instructions + +``` +$ mkdir build +$ cd build +$ cmake ../ +$ make +``` + +The above commands run from the project root will build the application. + +The cmake command can be substituted with `cmake -DUSE_QT5=yes ../` to explicitly use Qt5 over Qt6 or `cmake -DUSE_QT6=yes ../` to explicitly use Qt6 over Qt5. + +If using ninja instead of Makefiles, run `ninja` instead of `make` + +### Installation + +``` +# make install +``` + +The above command will install the application, as well as a desktop entry (if on Linux) + +Building installer packages using CPack is also supported for the following package formats: + +- DEB (`cpack -G DEB`) +- RPM (`cpack -G RPM`) -- cgit