Skip to content

Commit f414b80

Browse files
committed
📝 Update README with details about running vuegen using the cofig exmaple files
1 parent df2ea1e commit f414b80

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ vuegen --config docs/example_config_files/Earth_microbiome_vuegen_demo_notebook.
167167

168168
If a configuration file is given, users can specify titles and descriptions for sections and subsections, as well as component paths and required attributes, such as file format and delimiter for dataframes, plot types, and other details.
169169

170-
The component paths in the configuration file can be absolute or relative to the execution directory.
170+
The component paths in the configuration file can be absolute or relative to the execution directory. In the examples, we assume that the working directory is the `docs` folder, so the paths are relative to it. If you run VueGen from another directory, you need to adjust the paths accordingly.
171171

172172
The current report types supported by VueGen are:
173173

0 commit comments

Comments
 (0)