Skip to content

Commit e9cdac1

Browse files
Update tutorial.md
Added clarification point about where the sample_data is expected to be placed for the tutorial.
1 parent 62285c0 commit e9cdac1

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/tutorial.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,17 @@ Configuration file template:
6464
***This will be mostly same for all the projects, thus running this command is only recommended once per system.***
6565
6666
4. Create a project-specific configuration file
67-
This will create a project-specific configuration file template in the specified project directory.
67+
This will create a project-specific configuration file template in the specified project root directory.
6868
6969
```
7070
lslautobids gen-proj-config --project TestProject2025
7171
```
72+
73+
This will create a test-project_config.toml file in the project root directory.
74+
75+
> [!NOTE]: _For the rest of the tutorial, we are assuming that we place the downloaded sample_data in the root of the cloned LSLAutoBIDS repository and `LSLAutoBIDS` is cloned in the `home/users/` folder. In this case, the projects root will be `LSLAutoBIDS/sample_data/projects/` and so on for project_stimulus and bids._
76+
77+
7278
Fill in the details in the configuration file `LSLAutoBIDS/sample_data/projects/test-project/test-project_config.toml` file.
7379

7480
You can find the details about the parameters in the comments of the template configuration file generated. For this tutorial, you might want to just change the author and email fields. Rest of the fields are already filled in for the test project.

0 commit comments

Comments
 (0)