diff --git a/README.md b/README.md index 58f8cae07b54ba86dc7b5e8449503d3c7bfe6ce4..e44b4ef1ef6964c83aa20d35531402a8bed6b29f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,6 @@ will be pushed to a separate folder, and not directly appear on the website. Detailed information on how to create a merge request can be found [here](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html), but in most cases these two simple steps are sufficient: - - create a new branch in the repository on gitlab (either using the gitlab UI, or on the command line and then push to gitlab) - on top of the gitlab page you will see a blue "Create merge request" button associated with your new branch. Fill out the information, and don't forget to start the name of the merge request with "WIP:" @@ -31,9 +30,9 @@ ending `.md`. In particular, in markdown you can ``` !!! check "Example: optional title" The text of the example (could have math in it - $f(x)$), which must be indented by 4 spaces + $f(x)$), which must be indented by 4 spaces ``` - Other useful blocks are `!!! warning` and ``!!! info` + Other useful blocks are `!!! warning` and `!!! info` 3. Place figures in `src/figures` @@ -42,4 +41,4 @@ ending `.md`. In particular, in markdown you can 5. Whenever you push a commit to the branch/merge request, it will automatically be deployed on a preview webpage. This process may take a few minutes. You can find the preview website by going to your merge request. There will be on top a box with the label "Pipeline", and in the box a button "View app". Clicking on "View app" will bring you to the preview webpage. -6. When you are done with the merge request, remove "WIP:" from the title, and notify an instructor. \ No newline at end of file +6. When you are done with the merge request, remove "WIP:" from the title, and notify an instructor.