[system/kio-snapshot] /: update README
Bharadwaj Raju <[email protected]>
| Newsgroups | gmane.comp.kde.cvs |
|---|---|
| Message-ID | <[email protected]> |
Git commit 4941b56e8788a8119984dc33a127fdefc067ec6f by Bharadwaj Raju. Committed on 21/07/2026 at 09:30. Pushed by bharadwaj-raju into branch 'master'. update README M +9 -2 README.md https://invent.kde.org/system/kio-snapshot/-/commit/4941b56e8788a8119984dc33a127fdefc067ec6f diff --git a/README.md b/README.md index 5846bd8..8f87d73 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ -# KDE Snapshot Integration +# KIO Snapshot -User-facing integrations for Btrfs snapshots. +Integration of Btrfs filesystem snapshots for KDE apps. Includes: - [KIO workers](./kioworker) for browsing snapshots of a subvolume, and for browsing previous versions of a file - a [KFileItemActions plugin (context menu)](./contextmenu) for exposing these as menu items in Dolphin etc. + +## A note for users of Snapper + +If you use [Snapper](http://snapper.io/) as your tool for managing snapshots, you will need to add yourself to the `ALLOW_USERS` setting for your Snapper config, and also turn on `SYNC_ACL=yes`. +See http://snapper.io/manpages/snapper-configs.html and http://snapper.io/manpages/snapper-configs.html for more info. + +Distro integrators, if you want to ship KIO Snapshot and Snapper for snapshots of the user's home, please make sure that the above is already configured.