From b1ee452890a0e0a69e3c33bc627e27d3be92222c Mon Sep 17 00:00:00 2001 From: fedir Date: Tue, 20 May 2025 10:11:32 +0200 Subject: [PATCH] Updated readme --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b4ba479..17d4a6c 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,21 @@ Currently, there is no installer implemented. ## Usage -`icfs [target directory]` +``` +icfs [target directory] [path to permanent permission database] +``` -The filesystem will be mounted over the target directory, and ask user permission every time a file in that directory is opened. +The filesystem will be mounted over the target directory, and ask user permission every time a file in that directory is opened. Although filesystem must work as intended with no additional fuse arguments, we highly recommend adding `-o default_permissions` to increase performance and add an additional security layer. + +### Development build + +Execute this command in the root directory of this project: + +``` +env PATH="$(realpath ./build):$PATH" build/icfs [target directory] [path to permanent permission database] +``` + +The `env PATH="$(realpath ./build):$PATH"` adds the access dialogue program to PATH, allowing ICFS to call it seamlessly. ## Docs