From: Pieter De Praetere Date: Wed, 13 Jan 2021 21:38:03 +0000 (+0100) Subject: update readme X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=a8ef6c5acce74632050eeddae39ed04e9509aeb6;p=stands-website.git update readme --- diff --git a/README.md b/README.md index 3d571c4..21fad63 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ Welcome to FOSDEM 2021. This year, we have an experimental digital-only setup fo The stands.fosdem.org exhibition website is a static website generated with [Hugo](https://gohugo.io/). There is a general part, created by FOSDEM, containing an overview of each stand, a thematic ordering and some general information, and a stand-specific part. -We create the general part and will seed the stand-specific part with what you provided during your submission in the _\_index.md_. You can -update the contents of the file, but please make sure you do not remove any of the variables in the _[front matter](https://gohugo.io/content-management/front-matter/)_, otherwise the generator +We create the general part and will seed the stand-specific part with what you provided during your submission in the _project name.md_. You can +update the contents of the file (via a pull request), but please make sure you do not remove any of the variables in the _[front matter](https://gohugo.io/content-management/front-matter/)_, otherwise the generator will crash. We've asked for two repositories from you, one with the content (Hugo content files) and one with static files. These repositories do not have @@ -33,9 +33,9 @@ We will clone the repositories you provided in two locations (corresponding to t ### _index.md - * `content/stands//_index.md` - generated by our custom highly advanced (;-)) script based on what you provided in your submission. + * `content/stands/.md` - generated by our custom highly advanced (;-)) script based on what you provided in your submission. -The contents of the _\_index.md_ file can be changed as you wish, but please make sure you do not remove any of the variables (changing the content +The contents of the _.md_ file can be changed as you wish, but please make sure you do not remove any of the variables (changing the content is fine) of the _front matter_, otherwise the generator will not work. Please do not change the theme or the layout. #### Front matter @@ -101,8 +101,14 @@ We use Bootstrap (4.5) for styling, so you can as well. jQuery is included (for Please not that you cannot load any assets (images, css or js) from any other domain than stands.fosdem.org. ## Local development environment -To test your changes locally, this is what you can do. +To test your changes locally, this is what you can do (you'll need the Hugo binary). +1. Clone the repository. +2. Put your content directly in _content/stands/your stand_ and _static/stands/your stand_. We use submodules to link everything together, so your content must go there directly. +3. Run _hugo serve_. +4. Profit! + +If you notice anything amiss, let us know via _stands\_at\_fosdem\_dot\_org_. Or open a pull request ;-) ## Feedback