You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,39 +2,37 @@
2
2
3
3
Packer is a npm module that allows you to package apps built with NodeGui or React NodeGui into a standalone executable. Packer works on Mac, Windows and Linux
4
4
5
-
This is a initial MVP release of the module.
5
+
This is a initial MVP release of the module.
6
6
7
7
On MacOS - Packer will output a dmg file
8
8
9
9
On Linux - Packer will output an AppImage which is something similar to a .app file in MacOS
10
10
11
11
On Windows - Packer outputs a folder containing the executable and all the dlls.
12
12
13
-
Currently if you need to produce a build you need to run the packer in different OS environments. That is, cross platform builds are not supported in this release.
13
+
Currently if you need to produce a build you need to run the packer in different OS environments. That is, cross platform builds are not supported in this release.
14
14
15
15
# Usage
16
16
17
17
- First step is to install the packer as a dev dependency. You can do so by:
18
-
18
+
19
19
`npm install --save-dev @nodegui/packer`
20
20
21
21
- Next you can run the init command:
22
-
23
-
`npx nodegui-packer --init MyApp`
24
-
22
+
23
+
`npx nodegui-packer --init MyApp`
24
+
25
25
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.
26
26
27
27
- Next you can run the pack command:
28
-
28
+
29
29
`npx nodegui-packer --pack <path to dist>`
30
-
30
+
31
31
This command essential takes the dist folder as the input and puts it in the suitable location inside the standalone executable. Also it runs the correct deployment tool (macdeployqt incase of mac, etc) and packs in the dependencies. The output of the command is found under the build directory. You should gitignore the build directory.
32
-
32
+
33
33
- macOS supports signing the application:
34
34
35
-
`npx nodegui-packer --pack <path to dist> --sign <identity>`
36
-
37
-
Identity should be added to the keychain and trusted first. Its value can be copied from: `security find-identity -p codesigning`
35
+
`npx nodegui-packer --pack <path to dist>`
38
36
39
37
# How does it work ?
40
38
@@ -44,10 +42,9 @@ Packer uses Qt's packaging tools in all three platforms.
44
42
- On Windows - it uses windeployqt : https://doc.qt.io/qt-5/windows-deployment.html
45
43
- On Linux - There is no official tool, hence it uses linuxdeployqt - https://github.com/probonopd/linuxdeployqt
0 commit comments