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
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
### Welcome to the .NET **nanoFramework** firmware flasher tool repository
8
8
9
9
This repo contains the nano firmware flasher tool.
10
-
It's a [.NET Core CLI Global Tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) that allows flashing a .NET **nanoFramework** target with nanoBooter, nanoCLR, managed application or backup files.
10
+
It's a [.NET Core Tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) that allows flashing a .NET **nanoFramework** target with a firmware image (nanoBooter and nanoCLR), the application deployment (all assemblies required to run a .NET application) and restore previously saved deployment images.
11
11
Is part of .NET **nanoFramework** toolbox, along with other various tools that are required in .NET **nanoFramework** development, usage or repository management.
12
12
13
13
It makes use of several 3rd party tools:
@@ -34,7 +34,7 @@ You can invoke the tool using the following command: nanoff
34
34
Tool 'nanoff' (version '9.9.9') was successfully installed.
35
35
```
36
36
37
-
####Install path issues
37
+
### Install path issues
38
38
39
39
:warning: That are know issues running commands for STM32 devices when `nanoff` is installed in a path that contains diacritic characters. This is caused by a known bug in STM32 Cube Programmer.
40
40
If that's the case with your user path, for example, you have to install it in a location that does have those.
@@ -48,7 +48,7 @@ Note that if you're not using `nanoff` with STM32 devices, this limitation does
48
48
49
49
### MacOS users
50
50
51
-
You'll need to add nanoff to your path as well, once installed run:
51
+
You'll need to add `nanoff` to your path as well, once installed run:
52
52
53
53
```console
54
54
export PATH=$PATH:~/.dotnet/tools
@@ -82,17 +82,17 @@ The tool includes help for all available commands. You can see a list of all ava
82
82
nanoff --help
83
83
```
84
84
85
-
## ESP32 usage examples
85
+
## ESP32 usage examples
86
86
87
-
There are multiple ESP32 images available, some are build specifically for a target. Please check out the [list](https://github.com/nanoframework/nf-interpreter#firmware-for-reference-boards).
87
+
There are multiple ESP32 images available, some are build specifically for a target. Please check out the [list](https://github.com/nanoframework/nf-interpreter#firmware-for-reference-boards).
88
88
89
89
The ESP32_PSRAM_REV0 image will just work for any variant of the ESP32 series, with or without PSRAM, and for all silicon revisions.
90
90
You can read more about the differences between the various images [here](https://docs.nanoframework.net/content/reference-targets/esp32.html).
91
91
92
92
The FEATHER_S2 image will just work for pretty much all variants of the ESP32-S2 series that expose the embedded USB CDC pins.
93
93
You can read more about the differences between the various images [here](https://docs.nanoframework.net/content/reference-targets/esp32.html).
94
94
95
-
When using nanoff you can add `--target MY_TARGET_NAME_HERE` to use a specific image. If, instead, you just specify the platform with `--platform esp32` nanoff will choose the most appropriate image depending on the features of the device that's connected. Output similar to this one will show to advise what's the image about to be used:
95
+
When using `nanoff` you can add `--target MY_TARGET_NAME_HERE` to use a specific image. If, instead, you just specify the platform with `--platform esp32``nanoff` will choose the most appropriate image depending on the features of the device that's connected. Output similar to this one will show to advise what's the image about to be used:
96
96
97
97
```console
98
98
No target name was provided! Using 'ESP32_REV0' based on the device characteristics.
@@ -101,7 +101,7 @@ No target name was provided! Using 'ESP32_REV0' based on the device characterist
101
101
>Note: Please note that for ESP32-S2 targets is not possible to safely determine what's the best image to use. For this reason it's mandatory providing the appropriate target name with `--target MY_TARGET_NAME_HERE`.
102
102
103
103
Some ESP32 boards have issues entering bootloader mode. This can be usually overcome by holding down the BOOT/FLASH button in the board.
104
-
In case nanoff detects this situation the following warning is shown:
104
+
In case `nanoff` detects this situation the following warning is shown:
105
105
106
106
```console
107
107
*** Hold down the BOOT/FLASH button in ESP32 board ***
@@ -155,7 +155,7 @@ This example uses the binary format file that you can find when you are building
0 commit comments