Skip to content

Commit 4e86f2f

Browse files
committed
Improve docs
1 parent d7e1659 commit 4e86f2f

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
build/
22
dist/
33
node_modules/
4+
tmp-jam-pack-nodegui/

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# nodegui-simple-starter
1+
nodegui-simple-starter
2+
======================
23
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.
34

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.
56

67
This project can work with either `npm` or `yarn`.
78

89

910
Set up
1011
------
11-
1212
Run `npm install` to download and install the dependencies.
1313

1414
Building
@@ -21,6 +21,11 @@ Running
2121
`npm run run` will run the bundled application. Note, you will have to build it first.
2222

2323

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+
2429
Configured Scripts
2530
------------------
2631

@@ -29,6 +34,17 @@ Configured Scripts
2934
* `build-bundle` - Run `esbuild` to create the output bundle file in `dist`.
3035
* `clean` - Deletes the temporary files in `build` and `dist`.
3136
* `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.
47+
3248

3349
License
3450
-------

0 commit comments

Comments
 (0)