From 035d7ac7627cec51a85fcd8fc6865f7f724458aa Mon Sep 17 00:00:00 2001 From: "Koen van Eijk (aider)" Date: Tue, 1 Oct 2024 11:22:38 +0200 Subject: [PATCH] docs: Add uninstall instructions to the README.md for uninstalling openrecall and removing the stored data --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index d8b3465..ed11f74 100644 --- a/README.md +++ b/README.md @@ -97,3 +97,28 @@ mail@datatalk.be ## License OpenRecall is released under the [AGPLv3](https://opensource.org/licenses/AGPL-3.0), ensuring that it remains open and accessible to everyone. + +## Uninstall + +To uninstall OpenRecall and remove all stored data: + +1. Uninstall the package: + ``` + pip uninstall openrecall + ``` + +2. Remove stored data: + - On Windows: + ``` + rmdir /s %APPDATA%\openrecall + ``` + - On macOS: + ``` + rm -rf ~/Library/Application\ Support/openrecall + ``` + - On Linux: + ``` + rm -rf ~/.local/share/openrecall + ``` + +Note: If you specified a custom storage path using the `--storage-path` argument, make sure to remove that directory instead.