diff --git a/MAINTAINER b/MAINTAINER deleted file mode 100644 index dd1d8cb3..00000000 --- a/MAINTAINER +++ /dev/null @@ -1 +0,0 @@ -Vishesh Handa diff --git a/README.md b/README.md index f423e32d..44f1a5fd 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,48 @@ # Baloo ## Introduction -Baloo provides file searching and indexing. It does so by maintaining an index of the contents -of your files. +Baloo is the file indexing and file search framework for KDE Plasma. It focuses +on speed and a very small memory footprint. It maintains an index of your files +and optionally their contents which [you can search](@ref searching). ## Contributing Baloo is part of the KDE umberella and relies on the KDE infrastructure. **Mailing List:** kde-devel@kde.org ([info page](https://mail.kde.org/mailman/listinfo/kde-devel)) -**Bug Tracker:** http://bugs.kde.org ([new bug](https://bugs.kde.org/enter_bug.cgi?product=Baloo&format=guided)) +**Bug Tracker:** http://bugs.kde.org ([new bug](https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo)) **IRC Channel:** #kde-baloo on Freenode -The recommended way of contributing patches is via KDE's [reviewboard](http://reviewboard.kde.org). +The recommended way of contributing patches is via KDE's [phabricator](https://phabricator.kde.org). ## Documentation ### Users * [Searching](@ref searching) -* [FAQ](@ref baloo-faq) ### Developers -[![Build Status](https://build.kde.org/buildStatus/icon?job=baloo master kf5-qt5)](https://build.kde.org/job/baloo master kf5-qt5) -[![Coverity Scan Build Status](https://scan.coverity.com/projects/3259/badge.svg)](https://scan.coverity.com/projects/3259) - +[![build status](https://build.kde.org/job/Frameworks%20baloo%20kf5-qt5%20SUSEQt5.9/lastBuild/)](https://build.kde.org/buildStatus/icon?job=Frameworks%20baloo%20kf5-qt5%20SUSEQt5.9) * [Build Instructions](@ref build-instructions) -* [Coding Style](@ref coding-style) +* Baloo follows the [KDELibs coding style](https://techbase.kde.org/Policies/Kdelibs_Coding_Style). ### Distributions -* [General Notes](@ref distributing) +Baloo is developed and tested exclusively for Linux. While it may run on other +unix based systems. It is not recommended, and certainly not tested. + +We do not recommend to package Baloo for Windows or OSX as both these operating +systems offer their own file searching solutions which better integrate with +the native system than Baloo ever will. + +Baloo may run on 32-bit systems, but it has not been tested and may not work +correctly. Please test and let us know by [filing a bug](https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo). + +**Supported Kernels:** Linux +**Support Architecture:** x64 + +###### File Indexing Plugins + +Baloo relies on [KFileMetaData](https://api.kde.org/frameworks/kfilemetadata/html/index.html) to extract content from the files. KFileMetadata +ships with a number of plugins which can be enabled or disabled. We recommend +shipping all KFileMetaData plugins. Specially ffmpeg by default. Without the indexers, +Baloo cannot function to its full potential. diff --git a/docs/development/coding-style.md b/docs/development/coding-style.md deleted file mode 100644 index 8a5e3493..00000000 --- a/docs/development/coding-style.md +++ /dev/null @@ -1,3 +0,0 @@ -# Coding Style {#coding-style} - -Baloo follows the [KDELibs](https://techbase.kde.org/Policies/Kdelibs_Coding_Style) coding style. diff --git a/docs/distributing.md b/docs/distributing.md index 0eff280f..dc828652 100644 --- a/docs/distributing.md +++ b/docs/distributing.md @@ -1,22 +1,22 @@ # Distribution {#distributing} Baloo is developed and tested exclusively for Linux. While it may run on other unix based systems. It is not recommended, and certainly not tested. We recommend not packing Baloo for Windows or OSX as both these operating systems offer their own file searching solutions which better integrate with the native system than Baloo ever will. Baloo may run on 32-bit systems, but it has not been tested and may not work -correctly. Please test and let up know. +correctly. Please test and let us know by filing a bug at https://bugs.kde.org/enter_bug.cgi?product=frameworks-baloo. **Supported Kernels:** Linux **Support Architecture:** x64 ### File Indexing Plugins Baloo relies on KFileMetaData to extract content from the files. KFileMetadata ships with a number of plugins which can be enabled or disabled. We recommend shipping all KFileMetaData plugins. Specially ffmpeg by default. Without the indexers, Baloo cannot function to its full potential. diff --git a/docs/faq.md b/docs/faq.md deleted file mode 100644 index d6d220b4..00000000 --- a/docs/faq.md +++ /dev/null @@ -1,9 +0,0 @@ -# Frequently Asked Questions {#baloo-faq} - - -* How do I disable the this `baloo_file` process? -> Run `$ balooctl disable`. It won't bother you again. - -* How is Baloo different than updatedb? -> - diff --git a/docs/updatedb.md b/docs/updatedb.md deleted file mode 100644 index c17dcc70..00000000 --- a/docs/updatedb.md +++ /dev/null @@ -1,15 +0,0 @@ -Baloo vs UpdateDB ------------------ - -UpdateDB only searches through the filepath. - -Baloo searches through - - * MTime - * Mimetype - * Filename - * File Content - -Additionally, Baloo is optimized for searching and operating with very low latency -when searching. It does however consume more resources while writing and creating -the index. - diff --git a/metainfo.yaml b/metainfo.yaml index b6062c67..ea15bfaf 100644 --- a/metainfo.yaml +++ b/metainfo.yaml @@ -1,18 +1,18 @@ -maintainer: vhanda +maintainer: community maintained description: Baloo is a file indexing and searching framework tier: 3 type: solution platforms: - name: Linux - name: FreeBSD portingAid: false deprecated: false release: true libraries: - qmake: Baloo cmake: "KF5::Baloo" cmakename: KF5Baloo public_lib: true group: Frameworks subgroup: Tier 3