From: Pieter De Praetere <pieter.de.praetere@helptux.be>
Date: Wed, 20 Jan 2021 20:41:17 +0000 (+0100)
Subject: Update README.md
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=a5336e7099247ec63762c38360d68569aed91c55;p=stands-website.git

Update README.md
---

diff --git a/README.md b/README.md
index c703220..6257079 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,21 @@ and we will set it up.
 We automatically generate a link to your video repository and the chatroom.
 
 Your stand will live under _stands.fosdem.org/stands/<your project>_.
+ 
+## Workflow
+
+We need two repositories from you, one containing your content (pages) and one containing your static files. All files should go directly in the root of that repository (you should not create a hugo site, it is not necessary).
+
+To add your content to the [main website](https://stands.fosdem.org), two options are possible:
+
+ * Send us an e-mail with both repositories. We will add them as git submodules; content under _content/stands/your\_stand\_name_ (the name of your stand, or at least the directory, is the same name as the .md file already in _content/stands_ (minus the extension)) and static files under _static/stands/your\_stand\_name_.
+ * Fork and clone this repository, add them yourself (respect the paths please) and create a pull request.
+
+A cronjob will pull the code and rebuild the website every hour.
+
+If you wish to test your changes locally, you'll have to clone this repository, add the submodules as described above (synchronise them by executing _git submodule init_ and _git submodule update_) and test them with _hugo serve_. Any changes must be made in your local repositories.
+
+If you wish to change anything in the _content/stands/<your stand>.md_ file (which you can and should), please open a pull request.
 
 ## Directory structure
 
@@ -31,7 +46,7 @@ We will clone the repositories you provided in two locations (corresponding to t
 
 ## Important files
 
-### _index.md
+### _content/stands/<your stand>.md_
 
  * `content/stands/<your stand>.md` - generated by our custom highly advanced (;-)) script based on what you provided in your submission.