From 64832fec40a81cf7179e26430e96e71270d585aa Mon Sep 17 00:00:00 2001 From: Julien Schmidt <js@stusta.net> Date: Mon, 6 May 2019 14:36:35 +0200 Subject: [PATCH] README: dev instructions --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 05391db..6d5b228 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,19 @@ # External Website of StuStaNet e. V. +## Development + +The website generated from the sources in this repository using [Hugo](https://gohugo.io/). To preview the results of your changes, [install Hugo locally](https://gohugo.io/getting-started/installing). + +### Workflow +1. [Fork this repository](https://gitlab.stusta.de/stustanet/stustanet-website/forks/new) +2. Clone your repository locally: `cd` into the parent directory of where the files should be saved, then run `git clone https://gitlab.stusta.de/<your username>/stustanet-website.git` (Or use your favorite Git GUI). Afterwards `cd stustanet-website`. +3. Hugo can generate a live-preview of your changes. Run `hugo -v -w server` in the directory of the cloned repository. +4. Make and commit your changes +5. Push your changes to your fork on Gitlab (`git push`). +6. [Create a merge request](https://gitlab.stusta.de/stustanet/stustanet-website/merge_requests/new) + ## Board Data in `data/Vorstand.toml`, -### Notes +## Notes The stock photo for the wifi was taken from [https://www.stockvault.net/photo/176388/always-connected](https://www.stockvault.net/photo/176388/always-connected) -- GitLab