Recommend TIDY, explain res symlinks some more

Changes

1 changed files (+5/-1)

• README.md
  • @@ -14,4 +14,8 @@ ## Usage
    This program uses a client-server architecture to watch directories with inotify and keep the model loaded in memory. It takes around 15 seconds to load the model so it wouldn't be great if every query had to wait on that. - Run `python server.py DIRS_TO_INDEX` to start the server. Then, run `python client.py SEARCH_TEXT NUM_RESULTS` to get a list of the most similar files. You can pass this list to an image viewer such as Gwenview to view image results. Note that Gwenview doesn't preserve the order of the images. Alternatively, add a third parameter to `python client.py` and it will symlink `res0`, `res1`, and so on to the files on the list. + Run `python server.py DIRS_TO_INDEX` to start the server. The server only indexes images, audio, and videos since text files tend to irrelevantly pollute the search results. + + Then run `python client.py SEARCH_TEXT NUM_RESULTS` to get a list of the most similar files. You can pass this list to an image viewer such as Gwenview to view image results. Note that Gwenview doesn't preserve the order of the images. Alternatively, add a third parameter to `python client.py` and it will symlink `res0`, `res1`, and so on to the files on the list. This can be used in conjunction with the Dolphin file manager's integrated terminal to get thumbnails of the search results. + + Check out [TIDY](https://github.com/slavabarkov/tidy) for a similar awesome program that runs on Android.