simon987/sist2
1
0
Fork 0
mirror of https://github.com/simon987/sist2.git synced 2025-04-10 05:56:46 +00:00
Code Issues Projects Releases Wiki Activity

Some documentation updates

Browse Source
This commit is contained in:
simon987 2021-09-25 09:30:53 -04:00
parent 58741058cf
commit cd71551a22
4 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -10,7 +10,7 @@ sist2 (Simple incremental search tool)
*Warning: sist2 is in early development* *Warning: sist2 is in early development*
![sist2.png](docs/sist2.png) ![search panel](docs/sist2.png)
## Features ## Features
@ -52,7 +52,7 @@ sist2 (Simple incremental search tool)
1. Download the [latest sist2 release](https://github.com/simon987/sist2/releases) * 1. Download the [latest sist2 release](https://github.com/simon987/sist2/releases) *
1. *(or)* Download a [development snapshot](https://files.simon987.net/.gate/sist2/simon987_sist2/) *(Not 1. *(or)* Download a [development snapshot](https://files.simon987.net/.gate/sist2/simon987_sist2/) *(Not
recommended!)* recommended!)*
1. *(or)* `docker pull simon987/sist2:2.11.2-x64-linux` 1. *(or)* `docker pull simon987/sist2:2.11.3-x64-linux`
1. See [Usage guide](docs/USAGE.md) 1. See [Usage guide](docs/USAGE.md)

2
docs/USAGE.md
View File

@ -303,7 +303,7 @@ See [scripting](scripting.md) documentation.
# Sidecar files # Sidecar files
When scanning, sist2 will read metadata from `.s2meta` JSON files and overwrite the When scanning, sist2 will read metadata from `.s2meta` JSON files and overwrite the
original document's metadata. Sidecar metadata files will also work inside archives. original document's indexed metadata (does not modify the actual file). Sidecar metadata files will also work inside archives.
Sidecar files themselves are not saved in the index. Sidecar files themselves are not saved in the index.
This feature is useful to leverage third-party applications such as speech-to-text or This feature is useful to leverage third-party applications such as speech-to-text or

BIN
docs/manual_tag.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.9 KiB

After

Width:  |  Height:  |  Size: 35 KiB

BIN
docs/sist2.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 889 KiB

After

Width:  |  Height:  |  Size: 1011 KiB