From 642c33e8d956e265dd33e0f174a01cd310381e74 Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 25 Feb 2016 10:47:09 +0000 Subject: [PATCH] Mention package script in readme --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 48142bcca1..c88af54637 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,15 @@ You will need to re-run `npm run build` after editing `config.json`. Deployment ========== -For production use, run `npm run build` to build all the necessary files -into the `vector` directory. You can then mount the vector directory on -your webserver to actually serve up the app, which is entirely static content. +On a Unix-based OS, run `npm run package` to build a tarball package. Untaring +this file will give a version-specific directory containing all the files that +need to go on your web server. + +The package script is not supported on Windows, so Windows users can run `npm +run build`, which will build all the necessary files into the `vector` +directory. Note that the version of Vector will not appear in Settings without +using the package script. You can then mount the vector directory on your +webserver to actually serve up the app, which is entirely static content. Development ===========