diff --git a/gitlab-ci.yml b/.gitlab-ci.yml similarity index 100% rename from gitlab-ci.yml rename to .gitlab-ci.yml diff --git a/README.md b/README.md index 0316b6dc6dcf9855a300f8fd8edd09e5a0b4897d..78410ccffd64c28af2439ec57de6b85ed4522321 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,6 @@ 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. 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/`. +* 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/`. * 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.