From b5c43eacb3c5dc733281fcfca3c3f5dbddc86936 Mon Sep 17 00:00:00 2001 From: jon-lee Date: Thu, 27 Feb 2025 10:11:43 +0800 Subject: [PATCH] docs: update README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e2cc4c..8ad7169 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,16 @@ - `joj3-config-generator convert` function is now supported, currently support one argument as input, it indicates the **convert root** - default value on the server can be given as `/home/tt/.config/joj` - **NOTE:** the user should ensure that the ideal `repo.toml` file is in the sub-directory of the **convert root** - - the intended immutable files should be placed at same position as the `repo.toml` file + - the intended immutable files should be placed at a sub-directory named `immutable_files` at same position as the `repo.toml` file + +```shell +[nuvole0217@Nuvole test]$ tree . +. +|- immutable_files +| |-- push.yaml +| |-- release.yaml +|-- repo.toml +``` - sample command on the server ```shell