README.md 1.65 KB
Newer Older
Camilo Higuita's avatar
Camilo Higuita committed
1 2 3 4
# Index
Maui File manager

Index is a file manager that works on desktops, Android and Plasma Mobile.
Camilo Higuita's avatar
Camilo Higuita committed
5 6 7 8 9 10 11 12 13 14 15 16
Index lets you browse your system files and applications and preview your music, text, image and video files and share them with external applications.

## Build

### Dependencies
#### Qt core deps:
QT += qml, quick, sql

#### KF5 deps:
QT += KService KNotifications KNotifications KI18n KIOCore KIOFileWidgets KIOWidgets KNTLM

#### Submodules
17

Camilo Higuita's avatar
Camilo Higuita committed
18
##### MauiKit:
19 20

https://invent.kde.org/kde/mauikit/
Camilo Higuita's avatar
Camilo Higuita committed
21 22

##### qmltermwidget:
23

Camilo Higuita's avatar
Camilo Higuita committed
24 25 26
https://github.com/Swordfish90/qmltermwidget

### Compilation
27

Camilo Higuita's avatar
Camilo Higuita committed
28 29
After all the dependencies are met you can throw the following command lines to build Index and test it

30 31 32 33 34 35 36
``` bash
git clone https://invent.kde.org/kde/index-fm.git --recursive

cd index-fm && mkdir build && cd build

cmake .. -DCMAKE_INSTALL_INSTALL_PREFIX=/usr

Camilo Higuita's avatar
Camilo Higuita committed
37 38
make

39 40 41 42 43 44 45
# you can now run index like this:
./bin/index

# or install it on your system:
sudo make install
```

Camilo Higuita's avatar
Camilo Higuita committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
A binary should be created and be ready to use.

## Contribute
If you like the Maui project or Index and would like to get involve ther are several ways you can join us.
- UI/UX design for desktop and mobile platforms
- Plasma, KIO and Baloo integration
- Deployment on other platforms like Mac OSX, IOS, Windows.. etc.
- Work on data analysis and on the tagging system
And also whatever else you would like to see on a convergent file manager.

You can get in touch with me by opening an issue or email me:
chiguitar@unal.edu.co


## Screenshots
Camilo Higuita's avatar
Camilo Higuita committed
61 62 63 64 65 66 67 68

![Preview](https://i.imgur.com/mqKgyNu.png)

![Preview](https://i.imgur.com/BrOiUCj.png)

![Preview](https://i.imgur.com/lphJtNs.png)

![Preview](https://i.imgur.com/a3R2rDo.png)