diff --git a/README.md b/README.md index 6df602a9fab2ea19f14d861f81226c323abba85c..bdfe4dc3b58e684787e67b38aba1799658eac3f6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# Automatically push files from gitlab to canvas -Files and instructions to set up automatic pushing of files from gitlab to canvas. More information [here](https://wiki.control.lth.se/versionControl/canvasSync). +# Automatically upload files from gitlab to canvas +Files and instructions to set up automatic upload of files from gitlab to 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 your repo. +* Copy the `gitlab-ci.yml` file from this repo and place in the root of your repo. * 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/`. +* Rename `gitlab-ci.yml` to `.gitlab-ci.yml` * 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.