Updated documentation and added some videos

README.md

@@ -2,80 +2,12 @@
 
 ---
 
-Example [Hugo] website using GitLab Pages.
+To add your competition entry, you need to clone the repo to your computer using Vscode and then:
 
-Learn more about GitLab Pages at https://pages.gitlab.io and the official
+1. Create a new branch using the version control tab in vscode, please use "`first`-`last`" as the name of the branch where `first` is your first (i.e. _given_) name and `last` is your last (i.e. _family_) name.
-documentation https://docs.gitlab.com/ce/user/project/pages/.
+2. Rename the visualization video files to "`first`-`no`.mp4" where `first` is your first (i.e. _given_) name and `no` is a sequential number (e.g. "orwa-1.mp4", "orwa-2.mp4", etc.). If you are competing with one entry, then name the file "`first`.mp4" where `first` is your first (i.e. _given_) name.
-
+3. Store the video files in the subfolder `./static/video` in this repository
----
+4. Add your entry article and documentation to `./content/post` in this repository (please use the `2021-12-01-orwa-diraneyya.md` as an example)
-
+5. Commit your changes locally
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+6. Push your commits to the remote
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+7. Go to GitLab and create a merge request from there
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
-
-- [GitLab CI](#gitlab-ci)
-- [Building locally](#building-locally)
-- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
-- [Did you fork this project?](#did-you-fork-this-project)
-- [Troubleshooting](#troubleshooting)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## GitLab CI
-
-This project's static Pages are built by [GitLab CI][ci], following the steps
-defined in [`.gitlab-ci.yml`](.gitlab-ci.yml).
-
-## Building locally
-
-To work locally with this project, you'll have to follow the steps below:
-
-1. Fork, clone or download this project
-1. [Install][] Hugo
-1. Preview your project: `hugo server`
-1. Add content
-1. Generate the website: `hugo` (optional)
-
-Read more at Hugo's [documentation][].
-
-### Preview your site
-
-If you clone or download this project to your local computer and run `hugo server`,
-your site can be accessed under `localhost:1313/hugo/`.
-
-The theme used is adapted from http://themes.gohugo.io/beautifulhugo/.
-
-## GitLab User or Group Pages
-
-To use this project as your user/group website, you will need one additional
-step: just rename your project to `namespace.gitlab.io`, where `namespace` is
-your `username` or `groupname`. This can be done by navigating to your
-project's **Settings**.
-
-You'll need to configure your site too: change this line
-in your `config.toml`, from `"https://pages.gitlab.io/hugo/"` to `baseurl = "https://namespace.gitlab.io"`.
-Proceed equally if you are using a [custom domain][post]: `baseurl = "http(s)://example.com"`.
-
-Read more about [user/group Pages][userpages] and [project Pages][projpages].
-
-## Did you fork this project?
-
-If you forked this project for your own use, please go to your project's
-**Settings** and remove the forking relationship, which won't be necessary
-unless you want to contribute back to the upstream project.
-
-## Troubleshooting
-
-1. CSS is missing! That means two things:
-
-    Either that you have wrongly set up the CSS URL in your templates, or
-    your static generator has a configuration option that needs to be explicitly
-    set in order to serve static assets under a relative URL.
-
-[ci]: https://about.gitlab.com/gitlab-ci/
-[hugo]: https://gohugo.io
-[install]: https://gohugo.io/overview/installing/
-[documentation]: https://gohugo.io/overview/introduction/
-[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
-[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
-[post]: https://about.gitlab.com/2016/04/07/gitlab-pages-setup/#custom-domains

content/_index.md

@@ -1,7 +1,5 @@
 ## Front Page Content
 
-This website is powered by [GitLab Pages](https://about.gitlab.com/features/pages/)
+This website was setup in under 30 minutes using the HUGO project template on GitLab.
-/ [Hugo](https://gohugo.io) and can be built in under 1 minute.
+
-Literally. It uses the `beautifulhugo` theme which supports content on your front page.
+The website provides a showdown of all the visualizations created by the DSSIPD WiSe 2021/2022 students in the CR-Masters program in the RWTH Aachen university.
-Edit `/content/_index.md` to change what appears here. Delete `/content/_index.md`
-if you don't want any content here.