From 789137d498e806a83f43f89ad7ac15fa1f544be8 Mon Sep 17 00:00:00 2001 From: jon-lee Date: Thu, 27 Feb 2025 10:07:17 +0800 Subject: [PATCH] docs: update README --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f91bd7c..3e2cc4c 100644 --- a/README.md +++ b/README.md @@ -15,20 +15,16 @@ 3. Change dir to the repo, `cd JOJ3-config-generator` 4. Install deps by `pdm install && pdm run pre-commit install` 5. Run the cli app by `pdm run app --help` -<<<<<<< HEAD +6. Check other commands or scripts with `pdm run --list` ## How to use? -- `joj3-config-generator convert` function is now supported, currently support three flags: - - - `-d/--distribute`: Add it without other input, it indicates script is ready to convert things other than testcases within the project - - `-c/--conf-root`: This is where you want to put all your 'task.toml' type folders, default choice for your input can be '/home/tt/.config/joj/' - - `-r/--repo-root`: This would be where you put your 'repo.toml' file as well as your 'immutable files', they should all be at same place, default choice for your input can be 'immutable_files', which is the folder at the position '/home/tt/.config/joj/' +- `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 - sample command on the server ```shell -joj3-config-generator convert -d -c /home/tt/.config/joj/ -r immutable_files +joj3-config-generator convert /home/tt/.config/joj ``` -======= -6. Check other commands or scripts with `pdm run --list` ->>>>>>> master