Skip to content

Commit abefce8

Browse files
committed
build instructions
1 parent 46c77ed commit abefce8

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,26 @@ Dependencies
3232

3333
This depends on [js-moneysocket](https://github.com/moneysocket/js-moneysocket) which will need to be installed into `node_modules` prior to building this project.
3434

35-
Also, additional dependencies referenced are package.json
35+
Also, additional dependencies referenced are [package.json](package.json).
36+
37+
Build
38+
------------------------------------------------------------------------
39+
40+
Building is done with gulp, the details of which are detailed in [gulplfile.js](gulpfile.js).
41+
42+
After the dependencies are installed, the `htdocs/` web root directory can be built by running:
43+
44+
```
45+
$ gulp all
46+
```
47+
48+
Also, `gulp css`, `gulp js`, and the `js_watch` and `all_watch` varients might be useful for development workflows.
3649

3750

3851
Dev webserver
3952
------------------------------------------------------------------------
4053

41-
To access a camera from the browser for scanning QR, it needs to be served from a `https` server, or else the browser will be unhappy.
54+
To access a camera from the browser for scanning QR, it needs to be served from a `https` server during development, or else the browser will be unhappy.
4255

4356
[server.py](server.py) is provided with some certs that can be given exceptions for `localhost` from your browser while developing.
4457

0 commit comments

Comments
 (0)