Skip to content

Commit 9c7287a

Browse files
authored
Upgrade v0.15 (#58)
* Updates nodegui to 0.15.1 * update readme and bundle packer by default
1 parent 5970a64 commit 9c7287a

File tree

4 files changed

+525
-314
lines changed

4 files changed

+525
-314
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# nodegui-starter
22

3-
**Clone and run for a quick way to see NodeGUI in action.**
3+
**Clone and run for a quick way to see NodeGui in action.**
44

55
## To Use
66

@@ -21,10 +21,40 @@ npm install
2121
npm start
2222
```
2323

24-
## Resources for Learning NodeGUI
24+
## Resources for Learning NodeGui
2525

2626
- [docs.nodegui.org](https://nodegui.github.io/nodegui) - all of NodeGui and React Desktop's documentation
2727

28+
## Packaging app as a distributable
29+
30+
In order to distribute your finished app, you can use [@nodegui/packer](https://github.com/nodegui/packer)
31+
32+
### Step 1: (_**Run this command only once**_)
33+
34+
```sh
35+
npx nodegui-packer --init MyAppName
36+
```
37+
38+
This will produce the deploy directory containing the template. You can modify this to suite your needs. Like add icons, change the name, description and add other native features or dependencies. Make sure you commit this directory.
39+
40+
### Step 2: (_**Run this command every time you want to build a new distributable**_)
41+
42+
Next you can run the pack command:
43+
44+
```sh
45+
npm run build
46+
```
47+
48+
This will produce the js bundle along with assets inside the `./dist` directory
49+
50+
```sh
51+
npx nodegui-packer --pack ./dist
52+
```
53+
54+
This will build the distributable using @nodegui/packer based on your template. The output of the command is found under the build directory. You should gitignore the build directory.
55+
56+
More details about packer can be found here: https://github.com/nodegui/packer
57+
2858
## License
2959

3060
MIT

0 commit comments

Comments
 (0)