README: Rename project from 'qss' to 'looqs'

This commit is contained in:
Albert S. 2021-06-12 14:57:26 +02:00
parent 576b884574
commit 645903ed6b
5 changed files with 12 additions and 19 deletions

View File

@ -1,37 +1,30 @@
qss
=========
quite simple search (qss) creates a poor-man full-text search for your files using a sqlite database.
# looqs - Looks for files. And looks inside them
looqs creates a full text search for your files. It allows you to look at previews where your
search terms have been found.
A simple gui renders the pages of the documents where your search keywords have been found. Currently, this allows you search all indexed pdfs and take a look at the pages side by side in an instant.
Currently, this allows you search all indexed pdfs and take a look at the pages side by side in an instant.
The name of the project will probably be changed.
Screenshots
-----------
## Screenshots
Coming soon™
Goals
=====
## Goals
* **Find & Preview**. Instead of merely telling you where your search phrase has been found, it should also render the corresponding portion/pages of the documents and highlight the searched words.
* **No daemons**. As other solutions are prone to have annoying daemons running that eat system resources away, this solution should make do without daemons if possible.
* **Easy setup**. Similiarly, there should be no need for heavy-weight databases. Instead, this solution tries to squeeze out the most from simple approaches. In particular, it relies on sqlite.
* **GUI & CLI**. Provide CLI interfaces and GUI interfaces
Build
-----
### Ubuntu 20.04
## Build
### Ubuntu 21.04
```
sudo apt install build-essential qt5-default libpoppler-qt5-dev libuchardet-dev libquazip5-dev
sudo apt install build-essential qtbase5-dev libpoppler-qt5-dev libuchardet-dev libquazip5-dev
qmake
make
```
Documentation
-------------
## Documentation
Coming soon™
Packages
-----
## Packages
Coming soon™