update README

This commit is contained in:
Albert S. 2022-04-14 16:54:46 +02:00
parent 1cc7053193
commit a349d9bfe0

View File

@ -2,10 +2,21 @@
looqs creates a full text search for your files. It allows you to look at previews where your
search terms 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, as shown in the screenshots.
## Screenshots
Coming soon™
### List
![Screenshot looqs results](https://garage.quitesimple.org/assets/looqs/opearting_systems_looqs.png)
### Preview
![Screenshot looqs](https://garage.quitesimple.org/assets/looqs/orwell.png)
![Screenshot looqs search fstream](https://garage.quitesimple.org/assets/looqs/fstream_write.png)
## Current status
Last version: 2022-0X-XX, v0.1
Please see [Changelog](CHANGELOG.md) for a human readable list of changes.
## Goals and principles
@ -15,6 +26,9 @@ Coming soon™
* **GUI & CLI**. Provide CLI interfaces and GUI interfaces
* **Sandboxing**. As reading and rendering lots of formats naturally opens the door for security bugs, those tasks are offloaded to small, sandboxed sub-processes to mitigate the effect of exploited vulnerabilities.
## Supported platforms
Linux on amd64 is currently the main focus.
## Build
### Ubuntu 21.04
```