Warning, /maui/index-fm/README.md is written in an unsupported language. File is not indexed.
0001 # Index 0002 Maui File manager 0003 0004 Index is a file manager that works on desktops, Android and Plasma Mobile. 0005 Index lets you browse your system files and applications and preview your music, text, image and video files and share them with external applications. 0006 0007 <a href='https://flathub.org/apps/details/org.kde.index'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a> 0008 0009 ## Installation 0010 0011 Index can be installed on Arch Linux using the AUR Package [index-fm-git](https://aur.archlinux.org/packages/index-fm-git/) 0012 0013 ## Prerequsites for developers 0014 ### Ubuntu 0015 0016 **GCC and Build Essentials** 0017 ```shell 0018 sudo apt-get update 0019 sudo apt install build-essential libgl1-mesa-dev qtdeclarative5-dev libqt5svg5-dev \ qtquickcontols2-5-dev qt5-default 0020 sudo apt install cmake 0021 sudo apt install libkdecorations2-dev qml-module-qtquick-shapes 0022 ``` 0023 0024 **Install extra-cmake-module >5.60** 0025 ```shell 0026 git clone https://anongit.kde.org/extra-cmake-modules 0027 mkdir build && cd build 0028 cmake -DCMAKE_INSTALL_PREFIX=/usr .. && make 0029 make install 0030 ``` 0031 0032 **Install QT5 Libraries >5.10** 0033 Download and install QT binaries from Qt Open Source 0034 ``` 0035 https://www.qt.io/cs/c/?cta_guid=074ddad0-fdef-4e53-8aa8-5e8a876d6ab4&placement_guid=99d9dd4f-5681-48d2-b096-470725510d34&portal_id=149513&canon=https%3A%2F%2Fwww.qt.io%2Fdownload-open-source&redirect_url=APefjpHQjssyGwlBYE-rW_TcMDvQTTSN3igs_sES0bNmU4j3dNgz_g7U1gRD5rU9XP6QCagDltYNZe1mC_6yuR-J9-W2YmcKATNxGjM6fTT48JNue9VuRi4DK7LXluTHxwtZRv8NK3hLkSNlk4AKqcxomUJZqosxV3GK0cryzQm5xtWguoQg5Sg-E3LLyWQcat5flnqFkP-N5WbMKOQiHXZCCFTtzz-R5-48fCOn5EOIYCa4ePXGI-SHM-vf3KokrwZ_5LPenmO7pMJaXlm5vEoa1VyWrurg3A&click=f8615a00-0c1d-4cfe-8af2-2090813f25fa&hsutk=f0a10f80ae5765dd6d56a9d6725ee662&signature=AAH58kGBEuTlcag57Ka07aFLDeEt5qyytQ&pageId=12602948080&__hstc=152220518.f0a10f80ae5765dd6d56a9d6725ee662.1595615134675.1595615134675.1595615134675.1&__hssc=152220518.12.1595615134675&__hsfp=256125709&contentType=standard-page 0036 ``` 0037 0038 Download and install QT binaries from Qt Open Source 0039 ``` 0040 TODO GABRIDC 0041 ``` 0042 ```shell 0043 sudo apt install libqt5svg5-dev && qtquickcontols2-5-dev && qt5-default 0044 ``` 0045 0046 **Upgrade Qt libraries to 5.13** 0047 ```shell 0048 add source deb http://cz.archive.ubuntu.com/ubuntu groovy main universe 0049 sudo apt get update && upgrade 0050 ``` 0051 0052 **Install KF5 Libraries** 0053 Download and install KF5 Attica 0054 ```shell 0055 Requirement: KDE Neon 5.19 0056 sudo apt install gettext 0057 sudo apt install libkf5attica-dev libkf5kio-dev libkf5notifications-dev libkf5coreaddons-dev libkf5activities-dev libkf5i18n-dev libkf5declarative-dev libkf5plasma-dev libkf5syntaxhighlighting-dev 0058 ``` 0059 0060 **Download MAUI Kit** 0061 ```shell 0062 git clone https://invent.kde.org/maui/mauikit.git 0063 ``` 0064 0065 ## Build 0066 0067 We recommmend use KDE Neon for developing because KDE Neon has by default the latest version of Qt version supported in KDE Plasma. 0068 0069 Index-FM use Qt version 5.14.2 so we need this version or higer installed on ower host. 0070 0071 ### **KDE Neon >= 5.19.4** 0072 0073 **Check libraries and other components** 0074 0075 1. Update the latest version of default OS libraries: **Open Discover and install all updates** 0076 2. Check KDE Framework and Qt version installed: **Open System Settings > System Information** 0077 0078 0079 **GCC and Build Essentials** 0080 0081 ```shell 0082 sudo apt-get update 0083 sudo apt install cmake git 0084 sudo apt install build-essential libgl1-mesa-dev qtdeclarative5-dev libqt5svg5-dev qtquickcontrols2-5-dev qt5-default libkdecorations2-dev qml-module-qtquick-shapes 0085 ``` 0086 0087 **Install extra-cmake-module >5.60** 0088 ```shell 0089 cd <path to download extra-cmake-modules> 0090 git clone https://anongit.kde.org/extra-cmake-modules 0091 mkdir build && cd build 0092 cmake -DCMAKE_INSTALL_PREFIX=/usr .. && make 0093 make install 0094 ``` 0095 0096 **Install KF5 Libraries** 0097 Download and install KF5 Attica 0098 ```shell 0099 sudo apt install gettext 0100 sudo apt install libkf5attica-dev libkf5kio-dev libkf5notifications-dev libkf5coreaddons-dev libkf5activities-dev libkf5i18n-dev libkf5declarative-dev libkf5plasma-dev libkf5syntaxhighlighting-dev 0101 ``` 0102 0103 **Download and install MAUI KIT** 0104 0105 ```shell 0106 cd <path to download Maui> 0107 git clone https://invent.kde.org/maui/mauikit.git 0108 git checkout origin/development 0109 cd mauikit && mkdir build && cd build 0110 cmake -DCMAKE_INSTALL_PREFIX=/usr .. && make 0111 sudo make install 0112 ``` 0113 0114 ### **Other Host OS** 0115 0116 **Install QT5 Libraries >5.10** 0117 Download and install QT binaries from Qt Open Source 0118 ``` 0119 https://www.qt.io/cs/c/?cta_guid=074ddad0-fdef-4e53-8aa8-5e8a876d6ab4&placement_guid=99d9dd4f-5681-48d2-b096-470725510d34&portal_id=149513&canon=https%3A%2F%2Fwww.qt.io%2Fdownload-open-source&redirect_url=APefjpHQjssyGwlBYE-rW_TcMDvQTTSN3igs_sES0bNmU4j3dNgz_g7U1gRD5rU9XP6QCagDltYNZe1mC_6yuR-J9-W2YmcKATNxGjM6fTT48JNue9VuRi4DK7LXluTHxwtZRv8NK3hLkSNlk4AKqcxomUJZqosxV3GK0cryzQm5xtWguoQg5Sg-E3LLyWQcat5flnqFkP-N5WbMKOQiHXZCCFTtzz-R5-48fCOn5EOIYCa4ePXGI-SHM-vf3KokrwZ_5LPenmO7pMJaXlm5vEoa1VyWrurg3A&click=f8615a00-0c1d-4cfe-8af2-2090813f25fa&hsutk=f0a10f80ae5765dd6d56a9d6725ee662&signature=AAH58kGBEuTlcag57Ka07aFLDeEt5qyytQ&pageId=12602948080&__hstc=152220518.f0a10f80ae5765dd6d56a9d6725ee662.1595615134675.1595615134675.1595615134675.1&__hssc=152220518.12.1595615134675&__hsfp=256125709&contentType=standard-page 0120 ``` 0121 0122 0123 # Build 0124 0125 ### **Dependencies** 0126 0127 #### Qt core deps: 0128 QT += qml, quick, sql 0129 0130 #### KF5 deps: 0131 QT += KService KNotifications KI18n KIOCore KIOFileWidgets KIOWidgets KNTLM 0132 0133 ### **Submodules** 0134 0135 ### qmltermwidget: 0136 0137 https://github.com/Swordfish90/qmltermwidget 0138 0139 ```shell 0140 cmake .. -DCMAKE_INSTALL_PREFIX=/usr 0141 make 0142 sudo make install 0143 ``` 0144 ##### qmltermwidget: 0145 0146 Before continue preparing your developer environment it is necesary preapare your Gitlab account for developer in your fork and update latest commits. 0147 0148 0149 ### Compilation 0150 0151 ```shell 0152 cd <path to download Maui> 0153 git clone https://invent.kde.org/<username>/index-fm.git 0154 cd index-fm 0155 git config --global user.name "Your Invent KDE name" 0156 git config --global user.email "Your Invent KDE email" 0157 git remote add upstream https://invent.kde.org/maui/index-fm 0158 git pull upstream 0159 git checkout origin/development 0160 git pull --rebase upstream development 0161 ``` 0162 0163 ### KDE Neon >=5.19.4 0164 0165 After all the dependencies are met you can throw the following command lines to build Index and test it 0166 0167 ```shell 0168 mkdir build && cd build 0169 0170 cmake -DCMAKE_INSTALL_PREFIX=/usr .. && make 0171 ``` 0172 0173 ### Other Host OS 0174 0175 ```shell 0176 cmake .. -DCMAKE_INSTALL_INSTALL_PREFIX=/usr 0177 #-DQt5_DIR="/home/<username>/Qt/<Qt_Version>/gcc_64/lib/cmake/Qt5/" -DMauiKit_DIR="/home/gabridc/Repositorio/KDE/mauikit/" 0178 0179 cmake -DCMAKE_INSTALL_INSTALL_PREFIX=/usr -DQt5_DIR="/home/<username>/Qt/<Qt_Version>/gcc_64/lib/cmake/Qt5/" -DMauiKit_DIR="/home/gabridc/Repositorio/KDE/mauikit/" .. 0180 0181 make 0182 0183 # you can now run index like this: 0184 ./bin/index 0185 0186 # or install it on your system: 0187 sudo make install 0188 ``` 0189 0190 A binary should be created and be ready to use. 0191 0192 ## Contribute 0193 If you like the Maui project or Index and would like to get involve ther are several ways you can join us. 0194 - UI/UX design for desktop and mobile platforms 0195 - Plasma, KIO and Baloo integration 0196 - Deployment on other platforms like Mac OSX, IOS, Windows.. etc. 0197 - Work on data analysis and on the tagging system 0198 And also whatever else you would like to see on a convergent file manager. 0199 0200 You can get in touch with me by opening an issue or email me: 0201 chiguitar@unal.edu.co 0202 0203 0204 ## Screenshots 0205 0206  0207 0208  0209 0210  0211 0212 