Commit c4f1f369 authored by Camilo Higuita's avatar Camilo Higuita

Update README.md

parent 956600ed
......@@ -2,6 +2,47 @@
Maui File manager
Index is a file manager that works on desktops, Android and Plasma Mobile.
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
##### MauiKit:
https://github.com/maui-project/mauikit.git
##### qmltermwidget:
https://github.com/Swordfish90/qmltermwidget
### Compilation
After all the dependencies are met you can throw the following command lines to build Index and test it
git clone https://github.com/maui-project/index --recursive
cd index && mkdir build && cd build
qmake ..
make
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
![Preview](https://i.imgur.com/mqKgyNu.png)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment