docs: update README
This commit is contained in:
		
							parent
							
								
									789137d498
								
							
						
					
					
						commit
						b5c43eacb3
					
				
							
								
								
									
										11
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										11
									
								
								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** | - `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` |   - 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** |   - **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 | - sample command on the server | ||||||
| ```shell | ```shell | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue
	
	Block a user