summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam Thursfield <sam@afuera.me.uk>2020-10-20 18:05:23 +0000
committerSam Thursfield <sam@afuera.me.uk>2020-10-20 18:05:23 +0000
commit0b3071348ed49200658a5d0c8f6e7c6ba687f226 (patch)
tree063f8194a30b69721494c9ca6e6ffeae9d750848
parente181a35484cdf2455d0f76f0e6085217b89edf7a (diff)
parentebca3031a0514c239d767d67ad9b4852d9ae6046 (diff)
downloadtracker-0b3071348ed49200658a5d0c8f6e7c6ba687f226.tar.gz
Merge branch 'sam/more-docs' into 'master'
Tracker3 updates for README and website See merge request GNOME/tracker!331
-rw-r--r--README.md16
-rw-r--r--docs/website/overview.md25
2 files changed, 20 insertions, 21 deletions
diff --git a/README.md b/README.md
index 3e2e9e672..3de5b852e 100644
--- a/README.md
+++ b/README.md
@@ -6,22 +6,24 @@ and mobile.
The Tracker project is divided into two main repositories:
- * [Tracker core](https://gitlab.gnome.org/GNOME/tracker) contains the
+ * [Tracker SPARQL](https://gitlab.gnome.org/GNOME/tracker) contains the
triplestore database, provided as the `libtracker-sparql` library
and implemented using [SQLite](http://sqlite.org/). This repo also contains
- the database ontologies and the commandline user interface (`tracker`).
+ the database ontologies and the commandline user interface (`tracker3`).
* [Tracker Miners](https://gitlab.gnome.org/GNOME/tracker-miners) contains
- the indexer daemon (*tracker-miner-fs*) and tools to extract metadata
+ the indexer daemon (*tracker-miner-fs-3*) and tools to extract metadata
from many different filetypes.
More information on Tracker can be found at:
+ * <https://gnome.pages.gitlab.gnome.org/tracker/>
* <https://wiki.gnome.org/Projects/Tracker>
Source code and issue tracking:
* <https://gitlab.gnome.org/GNOME/tracker>
+ * <https://gitlab.gnome.org/GNOME/tracker-miners>
All discussion related to Tracker happens on:
@@ -111,22 +113,22 @@ shell.
Now check that it runs the correct version of the Tracker CLI:
- ./run-uninstalled -- tracker --version
+ ./run-uninstalled -- tracker3 --version
Let's try and index some content. (Subtitute ~/Music for any other location
where you have interesting data). We need to explicitly tell the script to wait
for the miners to finish, or it will exit too soon. (This is a workaround for
[issue #122](https://gitlab.gnome.org/GNOME/tracker/issues/122).)
- ./run-uninstalled --wait-for-miner=Files --wait-for-miner=Extract -- tracker index --file ~/Music
+ ./run-uninstalled --wait-for-miner=Files --wait-for-miner=Extract -- tracker3 index --file ~/Music
Let's see what files were found!
- ./run-uninstalled -- tracker sparql -q 'SELECT ?url { ?u nie:url ?url } }'
+ ./run-uninstalled -- tracker3 sparql -q 'SELECT ?url { ?u nie:url ?url } }'
Or, you can try a full-text search ...
- ./run-uninstalled -- tracker search "bananas"
+ ./run-uninstalled -- tracker3 search "bananas"
There are many more things you can do with the script.
diff --git a/docs/website/overview.md b/docs/website/overview.md
index 92ecaf9fe..cbed59ff3 100644
--- a/docs/website/overview.md
+++ b/docs/website/overview.md
@@ -2,14 +2,13 @@
## What is Tracker?
-Tracker is an efficient search engine and
-[triplestore](https://en.wikipedia.org/wiki/Triplestore) for desktop, embedded
-and mobile.
+Tracker is an efficient search engine and distributed database
+for desktop, embedded and mobile.
It is a middleware component aimed at desktop application developers who
want their apps to browse and search user content. It's not designed to be
used directly by desktop users, but it provides a commandline tool named
-`tracker` for the adventurous.
+`tracker3` for the adventurous.
Tracker allows your application to instantly perform full-text searches across
all documents. This feature is used by the 'search' bar in GNOME Files, for
@@ -26,18 +25,16 @@ If you need to go beyond simple searches, you'll be happy to know that
Tracker is also a [linked data](http://linkeddata.org/) endpoint and it
understands [SPARQL](https://www.w3.org/TR/2013/REC-sparql11-overview-20130321/).
-Apps can also store their own data in the Tracker database, but this feature
-isn't widely used yet. The [next major version of
-Tracker](https://gitlab.gnome.org/GNOME/tracker/-/milestones/1) aims to bring
-improvements in this regard.
+Apps can also store data in their own Tracker SPARQL database. If you want,
+this data can be published as a D-Bus service to enable distributed queries.
-There are several components that make up Tracker:
+Tracker 3 is divided into two subprojects:
- * **tracker-store**, which stores the index.
- * **tracker-miner-fs**, a daemon which crawls and monitors the filesystem to find content
- * **tracker-extract**, a suite of modules to extract metadata and content
- from many different types of file.
- * the **ontologies**, which define the database schema and the linked data vocabulary.
+ * [**Tracker SPARQL**](https://gitlab.gnome.org/GNOME/tracker), a
+ lightweight database library built around SQLite.
+ * [**Tracker Miners**](https://gitlab.gnome.org/GNOME/tracker-miners/),
+ a set of daemons which crawl the filesystem and extract metadata from
+ many types of file to provide a system-wide search service.
## Who uses Tracker?