[tracker-miners/wip/tintou/readme: 2/2] Switch to Markdown syntax
- From: Corentin Noël <corentinnoel src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tracker-miners/wip/tintou/readme: 2/2] Switch to Markdown syntax
- Date: Wed, 27 Mar 2019 08:12:49 +0000 (UTC)
commit 38f08caf55d96f3ed325b83e5b51913e85d54e5c
Author: Corentin Noël <corentin noel collabora com>
Date: Wed Mar 27 09:12:17 2019 +0100
Switch to Markdown syntax
README => README.md | 122 ++++++++++++++++++++++++++--------------------------
1 file changed, 61 insertions(+), 61 deletions(-)
---
diff --git a/README b/README.md
similarity index 51%
rename from README
rename to README.md
index 61db22764..4deaaff46 100644
--- a/README
+++ b/README.md
@@ -1,61 +1,61 @@
-1 Introduction
+# Tracker Miners
- Tracker is a search engine and that allows the user to find their
- data as fast as possible. Users can search for their files and
- search for content in their files too.
+Tracker is a search engine and that allows the user to find their
+data as fast as possible. Users can search for their files and
+search for content in their files too.
- Tracker is a semantic data storage for desktop and mobile devices.
- Tracker uses W3C standards for RDF ontologies using Nepomuk with
- SPARQL to query and update the data.
+Tracker is a semantic data storage for desktop and mobile devices.
+Tracker uses W3C standards for RDF ontologies using Nepomuk with
+SPARQL to query and update the data.
- Tracker is a central repository of user information, that provides
- two big benefits for the desktop; shared data between applications
- and information which is relational to other information (for
- example: mixing contacts with files, locations, activities and
- etc.).
+Tracker is a central repository of user information, that provides
+two big benefits for the desktop; shared data between applications
+and information which is relational to other information (for
+example: mixing contacts with files, locations, activities and
+etc.).
- This central repository works with a well defined data model that
- applications can rely on to store and recover their information.
- That data model is defined using a semantic web artifact called
- ontology. An ontology defines the relationships between the
- information stored in the repository.
+This central repository works with a well defined data model that
+applications can rely on to store and recover their information.
+That data model is defined using a semantic web artifact called
+ontology. An ontology defines the relationships between the
+information stored in the repository.
- An EU-funded project called Nepomuk was started to define some of
- the core ontologies to be modeled on the Desktop. Tracker uses this
- to define the data's relationships in a database.
+An EU-funded project called Nepomuk was started to define some of
+the core ontologies to be modeled on the Desktop. Tracker uses this
+to define the data's relationships in a database.
- All discussion related to tracker happens on the Tracker
- mailing list
+All discussion related to tracker happens on the Tracker
+mailing list
https://mail.gnome.org/mailman/listinfo/tracker-list
- IRC channel #tracker on:
+IRC channel #tracker on:
irc.gimp.net
- Bugs and feature requests should be filed at:
+Bugs and feature requests should be filed at:
https://gitlab.gnome.org/GNOME/tracker-miners/issues
- More infomation on Tracker can be found at:
+More infomation on Tracker can be found at:
https://wiki.gnome.org/Projects/Tracker
- Repository can be found at:
+Repository can be found at:
https://gitlab.gnome.org/GNOME/tracker-miners
- The official RoadMap (aka TODO) can be found at:
+The official RoadMap (aka TODO) can be found at:
https://wiki.gnome.org/Projects/Tracker/Roadmap
-2 Use Cases
+## Use Cases
- Tracker is the most powerful open source metadata database and
- indexer framework currently available and because it is built
- around a combination indexer and SQL database and not a
- dedicated indexer, it has much more powerful use cases:
+Tracker is the most powerful open source metadata database and
+indexer framework currently available and because it is built
+around a combination indexer and SQL database and not a
+dedicated indexer, it has much more powerful use cases:
* Provide search and indexing facilities similar to those on
other systems (Windows Vista and Mac OS X).
@@ -76,7 +76,7 @@
* Can provide a more intelligent desktop using statistical
metadata.
-3 Features
+## Features
* Desktop-neutral design (it's a freedesktop product built
around other freedesktop technologies like D-Bus and XDGMime
@@ -119,54 +119,54 @@
* It auto-pauses indexing when running low on diskspace.
-4 Compilation
+## Compilation
- To setup the project for compilation after checking it outfrom
- the git repository, use:
+To setup the project for compilation after checking it outfrom
+the git repository, use:
meson build --prefix=/usr --sysconfdir=/etc
- To start compiling the project use:
+To start compiling the project use:
ninja -C build
ninja install
- If you install using any other prefix, you might have problems
- with files not being installed correctly. (You may need to copy
- and amend the dbus service file to the correct directory and/or
- might need to update ld_conf if you install into non-standard
- directories.)
+If you install using any other prefix, you might have problems
+with files not being installed correctly. (You may need to copy
+and amend the dbus service file to the correct directory and/or
+might need to update ld_conf if you install into non-standard
+directories.)
-5 Running Tracker
+## Running Tracker
-5.1 Usage
+### Usage
- Tracker normally starts itself when users log in. You can indexing by running:
+Tracker normally starts itself when users log in. You can indexing by running:
$prefix/libexec/tracker-miner-fs
- You can configure how this works using:
+You can configure how this works using:
$prefix/bin/tracker-preferences
- You can monitor data miners using:
+You can monitor data miners using:
$prefix/bin/tracker-status-icon
- You can do simple searching using an applet:
+You can do simple searching using an applet:
$prefix/libexec/tracker-search-bar
- You can do more extensive searching using:
+You can do more extensive searching using:
$prefix/bin/tracker-search-tool
-5.2 Setting Inotify Watch Limit
+### Setting Inotify Watch Limit
- When watching large numbers of folders, its possible to exceed
- the default number of inotify watches. In order to get real time
- updates when this value is exceeded it is necessary to increase
- the number of allowed watches. This can be done as follows:
+When watching large numbers of folders, its possible to exceed
+the default number of inotify watches. In order to get real time
+updates when this value is exceeded it is necessary to increase
+the number of allowed watches. This can be done as follows:
1. Add this line to /etc/sysctl.conf:
"fs.inotify.max_user_watches = (number of folders to be
@@ -175,14 +175,14 @@
2. Reboot the system OR (on a Debian-like system) run
"sudo /etc/init.d/procps restart"
-6 Further Help
+## Further Help
-6.1 Man pages
+### Man pages
- Every config file and every binary has a man page. If you start with
- tracker-store, you should be able to find out about most other
- commands on the SEE ALSO section.
+Every config file and every binary has a man page. If you start with
+tracker-store, you should be able to find out about most other
+commands on the SEE ALSO section.
-6.2 Utilities
+### Utilities
- There are a range of tracker utilities that help you query for data.
+There are a range of tracker utilities that help you query for data.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]