From 4debe957b0e07b7f4149150c7f0f6b338645d1cc Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Fri, 11 Dec 2015 14:04:11 +0100 Subject: [PATCH] start basic documentation --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f3f3c4d --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# wp-theme + +> WordPress theme for Ascribe's landing page and blog + +## Prerequisites + +- node & npm +- composer + +```bash +npm install && composer +``` + +## Development + +On top of compiling css & js files, this starts a local, live-reloading server with BrowserSync: + +```bash +gulp +``` + +The task assumes the following: + +- WordPress exposed via MAMP under http://localhost:8888 + +The following compiles css & js files only: + +```bash +gulp build +```