Commit 9b92041b authored by Francisco Jesús Acién Pérez's avatar Francisco Jesús Acién Pérez
Browse files

updating README

parent cbcbed0e
......@@ -14,10 +14,17 @@ For installing Hugo in Linux just type `snap install hugo`
More info on: [Install Hugo](https://gohugo.io/getting-started/installing/)
## How to use Hugo?
You have to go to the root folder of the website and execute `hugo server`
You have to go to the root folder of the website and execute `snap run hugo server`
## Steps
1. `git clone https://lab.gsi.upm.es/docs/gsi-project-dashboard.git`
2. Adding new projects and demos.
3. Check the result with `snap run hugo server`
4. Upload your changes by creating a new branch and sending a Merge Request.
## How to add a new project?
......@@ -31,21 +38,36 @@ To add a new project copy the file `examples/project-example.md` to the folder `
Then, modify the file with your project info.
To see the project page execute `hugo server`.
To see the project page execute `snap run hugo server`.
## How to add a new demo?
To add a new project copy the file `examples/demo-example.md` to the folder `content/demos/` and name the file with the name of your project. For example:
To add a new demo copy the file `examples/demo-example.md` to the folder `content/demos/` and name the file with the name of your project. For example:
```
├── content
│ ├── projects
│ │ ├── ewetasker.md
│ ├── demos
│ │ ├── ewetasker-webclient.md
```
Then, modify the file with your project info.
Then, modify the file with your demo info.
To see the result execute `snap run hugo server`.
## How to upload your changes
Every person in the lab has permissions in this repository as developer. That means that **you are able to upload code on every branch except master**.
In order to upload your changes:
```
$ git checkout -b draft # Create a new branch
$ git add .
$ git commit -m "Uploading files"
$ git push origin draft
```
To see the project page execute `hugo server`.
Then a new branch is created. Now **you have to create a Merge Request**. To do so, go to GitLab and then to `Merge Requests->New merge request` and select your branch.
## Adding media
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment