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
+19-3Lines changed: 19 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
-
# nodegui-simple-starter
1
+
nodegui-simple-starter
2
+
======================
2
3
A [NodeGui](https://docs.nodegui.org/) application starter aiming to be fast and simple so that you can take it as a starting point and expand it to meet your needs.
3
4
4
-
The application itself is a very simple example which opens a window with some text and buttons in it. It is set up to probably support source maps for stacktraces, and also shows how to reference files elsewhere in the project.
5
+
The application itself is a very simple example which opens a window with some text and buttons in it. It is set up to properly support source maps for stacktraces, and also shows how to reference files elsewhere in the project.
5
6
6
7
This project can work with either `npm` or `yarn`.
7
8
8
9
9
10
Set up
10
11
------
11
-
12
12
Run `npm install` to download and install the dependencies.
13
13
14
14
Building
@@ -21,6 +21,11 @@ Running
21
21
`npm run run` will run the bundled application. Note, you will have to build it first.
22
22
23
23
24
+
Packaging
25
+
---------
26
+
`npm run package` will run [Jam Pack NodeGui](https://github.com/sedwards2009/jam-pack-nodegui) with a configuration file to create the relevant packages for the current operating system this is running on. The output appears in `tmp-jam-pack-nodegui/jam-pack-nodegui-work/`.
27
+
28
+
24
29
Configured Scripts
25
30
------------------
26
31
@@ -29,6 +34,17 @@ Configured Scripts
29
34
*`build-bundle` - Run `esbuild` to create the output bundle file in `dist`.
30
35
*`clean` - Deletes the temporary files in `build` and `dist`.
31
36
*`run` - Runs the application from the `dist` folder.
37
+
*`package` - Build packages for the application. The output appears in `tmp-jam-pack-nodegui/jam-pack-nodegui-work/`
38
+
39
+
40
+
Making it Yours
41
+
---------------
42
+
If you decide to use this a starting point for your own project, you will need to first update a number of configuration files which hold details of your project.
43
+
44
+
*`package.json` - The usual `name`, `description`, `author`, `license`, `repository url`, and `keywords` fields will need to be updated.
45
+
*`packaging/jam-pack-nodegui.json` - Many of the configurations for the different package types contain meta-data and package details which need updating. Also, icons will need to be replaced.
46
+
*`README.md` - This readme file will also need some heavy editing.
0 commit comments