From 56ede3d9cb922f0ceb8ebc57517e197d815df8e3 Mon Sep 17 00:00:00 2001 From: rscmbbng Date: Thu, 1 Nov 2018 18:56:22 +0100 Subject: [PATCH] Update README.md add instructions on the required plugins (in response to #2 ) --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 06bbd3f..b45209c 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,10 @@ Solar is a pelican theme designed for . It is The theme is designed to be extremely light and give visitors insight into the material conditions of the hardware the website runs on. -To this end we've developed a [few custom pelican plugins](https://github.com/lowtechmag/solar-plugins) and [additional scripts](https://github.com/lowtechmag/materialserver). +To this end we've developed a [few custom pelican plugins](https://github.com/lowtechmag/solar-plugins) and additional scripts called [materialserver](https://github.com/lowtechmag/materialserver). For this theme to work the plugins are *required*. The `materialserver` scripts are optional. ## Installation of dependencies -This theme is based on Pelican and a few custom plugins. - To generate the website you will need to install some basic utilities. Instructions are for machines based on Debian stretch. `sudo apt update && sudo apt install git python3-dev python3-setuptools python3-pip zlib1g-dev libjpeg-dev jq` @@ -21,4 +19,10 @@ Installing pelican: Installing dependencies for the plugins: `sudo pip3 install Pillow bs4 git+https://www.github.com/hbldh/hitherdither webassets libsass cssmin` +Install the plugins themselves: + +`git clone https://github.com/lowtechmag/solar-plugins` + +make sure you add that folder to the list of `PLUGIN_PATHS` in `pelicanconf.py` +