diff --git a/README.md b/README.md index c48a0cfb75338df3e4cf05337648ea753b0c4a95..db30a53e157af29928965d0366a3bf7ed6f58581 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,8 @@ # 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). + +## Setup +To set this up for a new repo there are three steps: +* 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. +* Add environment variables for the course code and canvas token in the new repo. This is done by navigating to Settings->CI/CD and adding variables. Add the variables CANVAS_COURSE_CODE and CANVAS_TOKEN with respective values (course code can be found in the url on the courses webpage, and token can be found on the wiki). +* Set up a runner. Navigate to the same location as in previous step, but instead pick runners in the end. Here are instructions on how to set up your computer as a runner for this project. Hopefully we will soon get shared runners so that we can skip this step.