]> git.sesse.net Git - plocate/blobdiff - README
Implement support for larger basevals in TurboPFor.
[plocate] / README
diff --git a/README b/README
index 820205236de9e9946b4a408e4ca97d8f31d7ebc9..64d9522a5a6b393fc5c539bfd4371de257ef9619 100644 (file)
--- a/README
+++ b/README
@@ -2,10 +2,20 @@ 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.
 
-Alpha stage; file format is subject to change. To build:
+Alpha stage; file format is subject to change. To build, run
 
-  git submodule init
-  make -j8
+  meson obj
+  cd obj
+  ninja
+
+If you wish to run some tests of the TurboPFor implementation against
+the reference implementation, you can run:
+
+  git clone https://github.com/powturbo/TurboPFor-Integer-Compression
+  ( cd TurboPFor-Integer-Compression && make -j8 )
+  cd obj
+  ninja reconfigure
+  ninja bench
 
 Copyright 2020 Steinar H. Gunderson <steinar+git@gunderson.no>.
 Licensed under the GNU General Public License, either version 2,