From 8755235664b5fcfc456db3cab7b863b3a2908494 Mon Sep 17 00:00:00 2001 From: "mb@mb" Date: Wed, 22 Aug 2018 21:52:18 +0200 Subject: [PATCH] updated the readme with ea. install * starting instructins --- README.md | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 31b1e10f..f4b06150 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,21 @@ The folder 'plugins' is linked to the Pelican project '[pelican-plugins](https:/ `git clone https://git.vvvvvvaria.org/varia/varia.website.git --recurse-submodules` + +## Install + +$ pip3 install -r requirements.txt + + +## Start + +You can make use of the makefile, for example by running the following command to start a python server: + +$ make devserver + +Visit the website at localhost:8000 + + ## Update submodules We are currently using two submodules: @@ -23,24 +38,26 @@ To update these submodules within your (already) cloned repository, first init t ## Posting Content -We're using a platform called pelican to generate static websites. The main way to add content to the website is by making 'posts' in the folder `content` +We're using Pelican to generate a static website. The main way to add content to the website is by making 'posts' in the folder `content`. -This can be done either locally or via the gitlab page by creating a new file. +This can be done either locally or via the gitlab interface by creating a new file. Make sure that each article contains at least the following at the top of the document: Title: een nieuw initiatief Date: 2017-07-07 18:32 Category: news - slug: the name of the html page - lang: nl or en + Tags: event, workshop + slug: the-name-of-the-html-page + lang: nl OR en -Articles are written in a language called markdown. [Here](https://daringfireball.net/projects/markdown/syntax) is an overview of the syntax. You can also use the online editor in gitlab to help you. +Articles are written in a markup language called markdown. [Here](https://daringfireball.net/projects/markdown/syntax) is an overview of the syntax. You can also use the online editor in gitlab to help you. -## Editing templates -todo -## The 'theme' +## Layout & theme todo +## Editing templates +todo +