mirror of
https://github.com/quine-global/hyper.git
synced 2026-01-13 04:28:41 -09:00
Readme: add dev build instructions (#3)
This commit is contained in:
parent
f88d54a444
commit
f6fc37eead
1 changed files with 27 additions and 0 deletions
27
Readme.md
27
Readme.md
|
|
@ -1,5 +1,32 @@
|
||||||
# hyperterm
|
# hyperterm
|
||||||
|
|
||||||
|
## Developing
|
||||||
|
|
||||||
|
To install `package.json` dependencies in a way where the native
|
||||||
|
modules are built with `electron`, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ ./install.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, you want to make sure `app/dist` is populated. I recommend
|
||||||
|
running `webpack` with `--watch` so that any changes you make
|
||||||
|
to the app are detected.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cd app/
|
||||||
|
$ npm install
|
||||||
|
$ webpack --watch
|
||||||
|
```
|
||||||
|
|
||||||
|
Then you can run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ electron index
|
||||||
|
```
|
||||||
|
|
||||||
|
to launch the app!
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- [ ] Warn upon quit
|
- [ ] Warn upon quit
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue