From 809afa599d58f3d9c1f94a4c6970cf1ff196a893 Mon Sep 17 00:00:00 2001 From: Kombie Date: Sun, 18 Aug 2019 12:14:28 +0100 Subject: [PATCH] [documentation] add build tool development commands --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fa9f055c..09268420 100644 --- a/README.md +++ b/README.md @@ -46,13 +46,17 @@ A neutral new tab page accented with a chosen colour. Customise the layout, styl ### Development -Make changes on files in the `/src/` directory. When ready the following can be used to build the project: +When developing use: +- `npm run dev` -- build web files with `npm run build-web` -- build extension zip with `npm run build-extension` -- build both web files and extension zip with `npm run build` +A Development copy will be created in `/dev/`. Open `/dev/index.html` in a browsers to test. Make changes on files in the `/src/` directory and refresh browser to see changes. -Build files can be found in `/dest/` + +To build the project use: +- `npm run build` + +A web ready folder will be created in `/build/web/`. +A browser addon/extension ready zip will be created at `/build/extension/`. ---