Jump to

step1-l1-2-readme

For the main README.md, you can use the following example :

# My full Lecture Title --- ShortTitle

Some quick summary of the content of the course.
Obviously, this can be done in more than one sentence ...

Note that you have to use the # title marker for your course title, and separate it from its short title with --- (short title is used on vignettes or browser tabs, for instance).

You can put as many details as you want in the description, those will be displayed on the index page of the course. For that, take a look at the Gitlab Flavored Markdown syntax, which provides some text formatting directives that can make the description well organized and easy to read. Don't hesitate to describe the different difficulty level for your questions like :

**Difficulty Levels :**

1. basic level, mandatory to pass
2. middle level, required for a correct grade
3. advanced level, required for a good grade
4. high level, eventually on subject not mentioned in the course

📜 You can also put there a link to the lecture material (slides, videos, ...), using the markdown syntax for links.

???