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
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ At the root of the repository you will find:
44
44
45
45
Arduino's default UI is a [choo-choo](https://github.com/choojs/choo) app. It has pre-built dependencies so no build process is required for the interface.
46
46
47
-
The dependencies and source code are included manually on the `/ui/arduino/index.html` file.
47
+
The dependencies and source code are included manually in the `/ui/arduino/index.html` file.
48
48
49
49
The app is a standard [choo-choo](https://github.com/choojs/choo) app and it has:
50
50
@@ -53,13 +53,13 @@ The app is a standard [choo-choo](https://github.com/choojs/choo) app and it has
53
53
-`/ui/arduino/store.js`: A "store" that handles events emitted by the views, change the app state and orchestrate re-rendering.
54
54
-`/ui/arduino/libs`: Prebuilt dependencies.
55
55
56
-
It can be useful to learn more about [Choo]((https://github.com/choojs/choo) or the [Elm Architecture](https://guide.elm-lang.org/architecture/).
56
+
It can be useful to learn more about [Choo](https://github.com/choojs/choo) or the [Elm Architecture](https://guide.elm-lang.org/architecture/).
57
57
58
58
## Disk and Serial API
59
59
60
60
In order for the UI code to be independent of Electron code, there is an API defined at `/preload.js` that describes all the allowed operations.
61
61
62
-
There are 2 main operation "channels": Serial communication and local Filesystem operations. Both channels offer methods that always return promises and are used mostly using[`async`/`await`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function).
62
+
There are 2 main operation "channels": Serial communication and local Filesystem operations. Both channels offer methods that always return promises and are used mostly through[`async`/`await`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function).
63
63
64
64
While the serial communication is mediated by `/micropython.js`, the local filesystem operations are done through Electron's `ipcRenderer` calls. The handlers for these calls are defined at `/index.js`
65
65
@@ -70,4 +70,4 @@ While the serial communication is mediated by `/micropython.js`, the local files
70
70
3. Install dependencies: `npm install`
71
71
4. Run dev mode: `npm run dev`
72
72
73
-
Changes on the Electron code will require reopening the app but UI changes only require refreshing the window (ctrl-r/cmd-r).
73
+
Some changes on the Electron code will require reopening the app but all UI changes will only require refreshing the window (ctrl-r/cmd-r).
0 commit comments