Update README: Document goals, minor improvements
Dieser Commit ist enthalten in:
Ursprung
ef78e74cdd
Commit
779248a6a6
18
README.md
18
README.md
@ -1,6 +1,6 @@
|
||||
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.
|
||||
|
||||
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
|
||||
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
|
||||
-----
|
||||
### Ubuntu 20.04
|
||||
@ -17,9 +26,6 @@ qmake
|
||||
make
|
||||
```
|
||||
|
||||
|
||||
Setup
|
||||
Packages
|
||||
-----
|
||||
sqlite3 qss.db < create.sql
|
||||
|
||||
TO BE WRITTEN
|
||||
Coming soon™
|
||||
|
Laden…
In neuem Issue referenzieren
Einen Benutzer sperren