From 71585322b6ee4fb54c0032649deb1e40a58b9fb2 Mon Sep 17 00:00:00 2001
From: Fredrik Jonsson <frjo@xdeb.org>
Date: Mon, 8 Oct 2018 13:41:50 +0200
Subject: [PATCH] Update README with gulp instructions.

---
 README.md | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index df325faa3..0d9c41c6f 100644
--- a/README.md
+++ b/README.md
@@ -37,16 +37,25 @@ This will make the site available on the host machine at: http://127.0.0.1:8000/
 
 # Updating front-end files
 
-Any changes made to sass or js files will need to be recompiled using:
+Any changes to sass and js files need to be made within the `opentech/static_src` directory. They then need to be compiled with the  help of "gulp".
+
+Start a vagrant SSH session and go to the project root directory.
+
+``` bash
+vagrant ssh
+cd /vagrant
+```
+
+Here you can run a number of different "gulp" commands. The two most useful are likely:
 
 ``` bash
-yarn build
+gulp watch
 ```
 
-Alternatively you can run the watcher that will rebuild on change to files:
+That will watch all fles for changes and build them with maps etc., perfect for development. (It will also run the "collecstatic" command, useful when running the site with a production server and not the built in dev server.)
 
 ``` bash
-yarn start
+gulp build
 ```
 
-Both commands should be run from within the `opentech/static_src` folder in the vagrant box.
+This will build all the files for production. For more command see the `gulpfile.js` file.
-- 
GitLab