Merge branch 'master' of github.com:freifunkhamburg/hamburg-freifunk-wp-theme

README.md

@@ -1,42 +1,48 @@
-hamburg-freifunk-wp-theme (2018)
+# hamburg-freifunk-wp-theme (2019)
+
+Wordpress Theme for the Website of Freifunk Hamburg, https://hamburg.freifunk.net with FoundationPress + Foundation 6 Sites
+
+## Installation
 
 FoundationPress relies to not-up-to-date dependencies, works with node.js ~6, use n to install older version node.js
 
-$ n 6
+`$ n 6`
 
-install gulp
+Install gulp
 
-$ sudo npm -g install gulp
+`$ sudo npm -g install gulp`
 
-install node modules
+Install node modules
 
-$ npm install
+`$ npm install`
 
-it there is a problem with babel versions, like
+If there is a problem with babel versions, like
 
 `
  babel-loader@8 requires Babel 7.x (the package '@babel/core'). If you'd like to use Babel 6.x ('babel-core'), you should install 'babel-loader@7'.
 `
+...try...
 
-try...
+`$ npm install --save-dev babel-loader@7`
 
-$ npm install --save-dev babel-loader@7
+Keep dependencies updated
 
+`$ ncu`
 
-keep dependencies updated
+`$ ncu -u`
 
-$ ncu
+(Install ncu with `$ npm install -g npm-check-updates`)
 
-$ ncu -u
+## Development
 
-(install ncu with $ npm install -g npm-check-updates)
+During design/development, render SCSS etc:
 
-during design/development, render SCSS etc:
+`$ npm start`
 
-$ npm start
+## Depliy
 
-render and pack for deployment
+Render and pack for deployment
 
-$ npm run package
+`$ npm run package`
 
 (zip file will be located in packaged folder)