Skip to content

Commit e91204d

Browse files
committed
Update readme
1 parent d74c840 commit e91204d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ At the root of the repository you will find:
4444

4545
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.
4646

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

4949
The app is a standard [choo-choo](https://github.com/choojs/choo) app and it has:
5050

@@ -53,13 +53,13 @@ The app is a standard [choo-choo](https://github.com/choojs/choo) app and it has
5353
- `/ui/arduino/store.js`: A "store" that handles events emitted by the views, change the app state and orchestrate re-rendering.
5454
- `/ui/arduino/libs`: Prebuilt dependencies.
5555

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/).
5757

5858
## Disk and Serial API
5959

6060
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.
6161

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).
6363

6464
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`
6565

@@ -70,4 +70,4 @@ While the serial communication is mediated by `/micropython.js`, the local files
7070
3. Install dependencies: `npm install`
7171
4. Run dev mode: `npm run dev`
7272

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

Comments
 (0)