From 060078beb9d832427744f68e91f03f2b2315f50c Mon Sep 17 00:00:00 2001 From: Albert S Date: Sun, 12 Aug 2018 16:47:55 +0200 Subject: [PATCH] updated README --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 23d76e4..6a68a53 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -easyindex +qss ========= -easyindex creates a poor-man full-text search for your files using a +qss creates a poor-man full-text search for your files using a sqlite database. You need the python "chardet" package, since it will try to convert the @@ -8,11 +8,21 @@ encoding of the files in case initial utf-8 decoding fails. pdftext is needed to search in .pdf files.. -No GUI is provided at this time, nor does it concern itself with search -too much. +A simple gui (C++ with Qt5) for search is found in gui/. +It shows preview pages of documents where your search keywords have +been found. This allows you to search all indexed pdfs and take a look +at the pages side by side in an instant. + +Build +----- +TO BE WRITTEN Setup ----- -sqlite3 easyindex.db < create.sql +sqlite3 qss.db < create.sql + +TO BE WRITTEN + +