Mention package script in readme
This commit is contained in:
parent
fa322e8488
commit
642c33e8d9
1 changed files with 9 additions and 3 deletions
12
README.md
12
README.md
|
@ -35,9 +35,15 @@ You will need to re-run `npm run build` after editing `config.json`.
|
||||||
Deployment
|
Deployment
|
||||||
==========
|
==========
|
||||||
|
|
||||||
For production use, run `npm run build` to build all the necessary files
|
On a Unix-based OS, run `npm run package` to build a tarball package. Untaring
|
||||||
into the `vector` directory. You can then mount the vector directory on
|
this file will give a version-specific directory containing all the files that
|
||||||
your webserver to actually serve up the app, which is entirely static content.
|
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
|
Development
|
||||||
===========
|
===========
|
||||||
|
|
Loading…
Reference in a new issue