Update README: Document goals, minor improvements
This commit is contained in:
parent
bbe8b1f530
commit
1ad8d632c1
18
README.md
18
README.md
@ -1,6 +1,6 @@
|
|||||||
qss
|
qss
|
||||||
=========
|
=========
|
||||||
qss creates a poor-man full-text search for your files using a
|
quite simple search (qss) creates a poor-man full-text search for your files using a
|
||||||
sqlite database.
|
sqlite database.
|
||||||
|
|
||||||
A simple gui (C++ with Qt5) for search is found in gui/.
|
A simple gui (C++ with Qt5) for search is found in gui/.
|
||||||
@ -8,6 +8,15 @@ 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
|
been found. This allows you to search all indexed pdfs and take a look
|
||||||
at the pages side by side in an instant.
|
at the pages side by side in an instant.
|
||||||
|
|
||||||
|
The name of the project will probably be changed.
|
||||||
|
|
||||||
|
Goals
|
||||||
|
=====
|
||||||
|
* **Find & Preview**. Instead of merely telling you where your search phrase has been found, it actually shows it too.
|
||||||
|
* **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 solutions tries to squeeze out the most from simple approaches. In particular, it relies on sqlite.
|
||||||
|
* **GUI & CLI**. Provide CLI interfaces and GUI interfaces
|
||||||
|
|
||||||
Build
|
Build
|
||||||
-----
|
-----
|
||||||
### Ubuntu 20.04
|
### Ubuntu 20.04
|
||||||
@ -17,9 +26,6 @@ qmake
|
|||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Packages
|
||||||
Setup
|
|
||||||
-----
|
-----
|
||||||
sqlite3 qss.db < create.sql
|
Coming soon™
|
||||||
|
|
||||||
TO BE WRITTEN
|
|
||||||
|
Loading…
Reference in New Issue
Block a user