Verified Commit c9fd4d85 authored by Camil Staps's avatar Camil Staps 🚀

Write about distribution in README

parent 453315e3
......@@ -104,8 +104,24 @@ your `Start` rule.
To run the application you only need to run the executable. You do not need to
run the JavaScript code yourself; this is done automatically by Clean.
## Distributing
To distribute your application you don't want your users to have to install
Node.js. It is possible to package Electron applications complete with a Chrome
runtime, so that you get a completely stand-alone application.
To do this with an iTasks-Electron application, you need to write a `build.js`
script that collects all relevant files and uses
[`electron-packager`][electron-packager] to create a stand-alone distribution.
I am still in the process of creating helper functions to easily write a
`build.js`. For now, you can see how it is done in TextSheets:
- https://gitlab.com/camilstaps/text-sheets/-/blob/master/src/build.js
- https://gitlab.com/camilstaps/text-sheets/-/blob/master/.gitlab-ci.yml
[Electron]: https://www.electronjs.org/
[Electron-BrowserWindow]: https://www.electronjs.org/docs/api/browser-window
[electron-packager]: https://www.npmjs.com/package/electron-packager
[iTasks]: https://gitlab.science.ru.nl/clean-and-itasks/iTasks-SDK/
[Node.js]: https://nodejs.org/en/
[ObjectIO]: https://clean.cs.ru.nl/Object_I/O
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment