Update README.md

add  instructions on the required plugins (in response to #2  )
master^2
rscmbbng 2018-11-01 18:56:22 +01:00 zatwierdzone przez GitHub
rodzic 0810095010
commit 56ede3d9cb
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 7 dodań i 3 usunięć

Wyświetl plik

@ -4,12 +4,10 @@ Solar is a pelican theme designed for <https://solar.lowtechmagazine.com>. 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`