Skip to content

Commit 9d68775

Browse files
doc: rephrase dev section
1 parent a48fb99 commit 9d68775

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

GET_STARTED.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
1. First [download and install Visual Studio Code](https://code.visualstudio.com/).
44
2. Install the [Pymakr VSCode Extension](https://marketplace.visualstudio.com/items?itemName=pycom.Pymakr)
5-
6-
_(We're installing the preview, but once the project reaches "stable" we'll, be using the regular extension.)_
75

8-
<img src="./media/readme/install-pymakr.gif" />
6+
_(We're installing the preview, but once the project reaches "stable" we'll, be using the regular extension.)_
7+
8+
<img src="./media/readme/install-pymakr.gif" />
99

1010
3. That's it! You've installed the Pymakr Extension for VSCode
1111

@@ -35,27 +35,30 @@ Once the project is ready to run, it needs to be uploaded to a device.
3535

3636
To speed up development, you can put a project in `development mode`.
3737

38-
In development mode, Pymakr automatically propagates file changes in and restarts the main script.
38+
In development mode, Pymakr automatically propagates local file changes to connected devices and then restarts the main script.
3939

4040
Dev mode can be configured in `pymakr.json`
41+
4142
```json
4243
{
43-
"onUpdate": "restartScript" | "softRestartDevice" | "hardRestartDevice"
44+
"onUpdate": "restartScript" | "softRestartDevice" | "hardRestartDevice"
4445
}
4546
```
4647

4748
**onUpdate:** Action to be called once file changes have been propagated.
49+
4850
- **restartScript** Clears the `main.py` module as well as any changed modules. Then imports `boot.py` and `main.py`.
4951
- **softRestartDevice** Performs <kbd>ctrl + d</kbd>
5052
- **hardRestartDevice** Performs `machine.reset()`
5153

5254
#### NOTE
53-
*`machine.sleep` and `machine.deepsleep` do not work in development since they stop the USB connection.*
55+
56+
_`machine.sleep` and `machine.deepsleep` do not work in development since they stop the USB connection._
5457

5558
---
5659

5760
## Hint: Organizing your setup
5861

5962
Having to switch between different tabs can be cumbersome. To solve this, you can drag your devices and projects to the file explorer view.
6063

61-
![](./media/readme/move-view.gif)
64+
![](./media/readme/move-view.gif)

0 commit comments

Comments
 (0)