diff --git a/README.md b/README.md index 97219fbe39c1dc59cc9b8bf4450a7fa60b57b8cb..0316b6dc6dcf9855a300f8fd8edd09e5a0b4897d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Automatic sync between gitlab and canvas -File to handle automatic syncing of files between gitlab and canvas. Mor information [here](https://wiki.control.lth.se/versionControl/canvasSync). +File to handle automatic syncing of files between gitlab and canvas. More information [here](https://wiki.control.lth.se/versionControl/canvasSync). ## Setup * Copy the gitlab-ci.yml file from this repo and place in the root of the new repo with the name .gitlab-ci.yml, notice the dot at the start of the name. -* Modify the environment variable CANVAS_COURSE_CODE in the new file to correspond to the course code canvas uses in its url. -* Create the folder `to_canvas` in the root of the repository and put files you want synced there. +* Modify the environment variable CANVAS_COURSE_CODE in the new file to correspond to the course code canvas uses in its url. This can be found by opening the canvas page for the course and looking at the url, it should be of the form `https://canvas.education.lu.se/courses/ID_NUMBER/`. +* Create the folder `to_canvas` in the root of the gitlab repository and put any files/folders that should be synced in there. They will show up in a `from_git` folder in the canvas file explorer.