X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=README;h=f2c6cb862c4f962728e5e9afdfa0c0f0ef14ed7b;hb=fd6198891d6fd9642effc0843fef6f23b991af3e;hp=820205236de9e9946b4a408e4ca97d8f31d7ebc9;hpb=12cf48afe678b047fec19b76e14a3e8b29bb33f6;p=plocate

diff --git a/README b/README
index 8202052..f2c6cb8 100644
--- a/README
+++ b/README
@@ -1,12 +1,46 @@
-plocate, a locate based on posting lists, consuming mlocate inputs
-and making a much faster index. Does not support querying by regex,
-case-insensitivity or really any options.
+plocate is a locate based on posting lists. Compared to mlocate,
+it is much faster, and its index is much smaller. updatedb speed
+is similar (or you can convert mlocate's index to plocate format
+using plocate-build). It supports most mlocate options;
+see --help or the man page (man -l plocate.1) for more information.
 
-Alpha stage; file format is subject to change. To build:
+The file format may still change (if so, plocate will notify you itself
+that you need to rerun plocate-build or updatedb). To build and install,
+you will need a C++17 compiler and a development package for Zstd
+(https://facebook.github.io/zstd/). liburing (https://github.com/axboe/liburing)
+and a kernel supporting io_uring (Linux 5.1 or newer) is optional,
+but strongly recommended for best performance, especially if you
+do not have an SSD. Installation is run as:
 
-  git submodule init
-  make -j8
+  meson obj
+  cd obj
+  ninja
+  sudo addgroup --system plocate
+  sudo ninja install
+  sudo systemctl enable plocate-updatedb.timer
 
-Copyright 2020 Steinar H. Gunderson <steinar+git@gunderson.no>.
+To build the database for the first time after install, you can do
+
+  sudo updatedb
+
+The initial run of updatedb needs to scan the entire filesystem.
+Subsequent runs of updatedb will be much faster, and create a slightly (~5%)
+smaller database.
+
+If you wish to run some tests of the TurboPFor implementation against
+the reference implementation, you can check it out and run as follows:
+
+  git clone https://github.com/powturbo/TurboPFor-Integer-Compression
+  ( cd TurboPFor-Integer-Compression && make -j8 )
+  cd obj
+  ninja reconfigure
+  ninja bench
+
+plocate (except updatedb), and the plocate-specific changes to updatedb,
+is Copyright 2020 Steinar H. Gunderson <steinar+plocate@gunderson.no>.
 Licensed under the GNU General Public License, either version 2,
 or (at your option) any later version. See the included file COPYING.
+
+updatedb is Copyright (C) 2005, 2007 Red Hat, Inc. All rights reserved.
+Licensed under the GNU General Public License, version 2. See the
+included file COPYING.