Skip to content

Commit 39b7f2d

Browse files
committed
docs: documentation for binaries
1 parent 8d85aa9 commit 39b7f2d

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ For AppImages, it is sadly not straightforward to access the packaged node_modul
9696

9797
## Electron / Vue
9898

99-
10099
### API
101100

102101
Electron uses an RPC API to facilitate communication between frontend and backend tasks. All operations requiring system API calls must be executed on the Electron backend.
@@ -113,6 +112,14 @@ We use [Pinia](https://github.com/vuejs/pinia), a straightforward and simple glo
113112

114113
For app-wide translations, we utilize the `I18next` internationalization framework. Adding, updating, creating, and deleting translations is as simple as creating or editing a file in the `renderer/locales` folder and then registering the new languages in the `renderer/src/main.ts` file.
115114

115+
### Extra binaries
116+
117+
To rebuild the `.iso` image, we use the `xorriso` binary. Unfortunately, this binary is not available on macOS and Windows. Therefore, we provide a statically cross-compiled binary for both Windows and Linux.
118+
119+
These binaries are distributed using the [extraResources](https://www.electron.build/configuration/contents.html#extraresources) property of Electron Builder and are utilized during the flashing process.
120+
121+
You can find the binaries in the `resources/binaries` folder.
122+
116123
## Important notes:
117124

118125
The etcher-sdk only works up to electron 19 due to security changes made in electron 20+

0 commit comments

Comments
 (0)