Skip to content

Commit e086f45

Browse files
authored
Merge pull request #149 from rage/merge-change
documented the course-wide config file
2 parents 532e86b + f42d205 commit e086f45

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/tmcproject.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Exercises can be configured by adding an optional `.tmcproject.yml` file to the exercise root directory.
1+
Exercises can be configured by adding an optional `.tmcproject.yml` file to the exercise root directory. Additionally, a course-wide file can be added to the course's root. When the course is then refreshed, the course-wide file is merged with the exercise-specific ones for the exercise stub and solution. For each key-value pair in the course-wide file, if the key is not present in the exercise-specific file, it is added to it with the course-wide file's value.
22

33
## Keys
44

@@ -13,7 +13,7 @@ All of the keys listed below are optional.
1313
| no-tests | Boolean OR Map "points" -> List of string OR integer | If set to true or a map, the no-tests plugin is used for the exercise. If set to a list, the list will be used as the exercise's points. |
1414
| fail_on_valgrind_error | Boolean | If set, the C plugin will attempt to run valgrind and fail the exercise if it discovers errors. |
1515
| minimum_python_version | Python version string | Must be "{major}.{minor}.{patch}", "{major}.{minor}" or "{major}". If set, the Python plugin will warn the user if the Python version being used is below the given minimum version. |
16-
| sandbox_image | The Docker image that should be used at the sandbox. | Should be a URL. |
16+
| sandbox_image | The Docker image that should be used at the sandbox. | Should be the Docker registry path of the image. |
1717

1818
## Example file contents
1919

0 commit comments

Comments
 (0)