Skip to content

Commit fcc0515

Browse files
authored
Update README.md
1 parent c12b95d commit fcc0515

File tree

1 file changed

+34
-40
lines changed

1 file changed

+34
-40
lines changed

README.md

+34-40
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,34 @@
1-
# Arduino ESP32 filesystem uploader
2-
3-
Arduino plugin which packs sketch data folder into SPIFFS filesystem image,
4-
and uploads the image to ESP32 flash memory.
5-
<br>
6-
Tested with the following Arduino IDE versions: 1.6.5-r2,
7-
1.6.6
8-
9-
10-
11-
## Installation
12-
- Make sure you use one of the supported versions of Arduino IDE and have ESP32 core installed.
13-
- Download the tool archive from [releases page](https://github.com/esp32/arduino-esp32fs-plugin/releases/latest).
14-
- In your Arduino sketchbook directory, create tools directory if it doesn't exist yet.
15-
- Unpack the tool into tools directory (the path will look like `<home_dir>/Arduino/tools/ESP32FS/tool/esp32fs.jar)`.
16-
- Restart Arduino IDE.
17-
18-
On the OS X create the tools directory in ~/Documents/Arduino/ and unpack the files there
19-
20-
## Usage
21-
- Open a sketch (or create a new one and save it).
22-
- Go to sketch directory (choose Sketch > Show Sketch Folder).
23-
- Create a directory named `data` and any files you want in the file system there.
24-
- Make sure you have selected a board, port, and closed Serial Monitor.
25-
- Select *Tools > ESP32 Sketch Data Upload* menu item. This should start uploading the files into ESP32 flash file system.
26-
When done, IDE status bar will display SPIFFS Image Uploaded message. Might take a few minutes for large file system sizes.
27-
28-
## Screenshot
29-
30-
![Screenshot](screenshot.png)
31-
32-
## Credits and license
33-
34-
- Copyright (c) 2015 Hristo Gochkov (hristo at espressif dot com)
35-
- Licensed under GPL v2 ([text](LICENSE))
36-
- Maintained by Hristo Gochkov (hristo at espressif dot com)
37-
38-
## Issues and suggestions
39-
40-
File issues here on github, or ask your questions on the [esp32.com forum](http://esp32.com).
1+
# Arduino ESP32 filesystem uploader
2+
3+
Arduino plugin which packs sketch data folder into SPIFFS filesystem image,
4+
and uploads the image to ESP32 flash memory.
5+
6+
## Installation
7+
8+
- Make sure you use one of the supported versions of Arduino IDE and have ESP32 core installed.
9+
- Download the tool archive from [releases page](https://github.com/me-no-dev/arduino-esp32fs-plugin/releases/latest).
10+
- In your Arduino sketchbook directory, create tools directory if it doesn't exist yet.
11+
- Unpack the tool into tools directory (the path will look like ```<home_dir>/Arduino/tools/ESP32FS/tool/esp32fs.jar```).
12+
- Restart Arduino IDE.
13+
14+
On the OS X create the tools directory in ~/Documents/Arduino/ and unpack the files there
15+
16+
## Usage
17+
18+
- Open a sketch (or create a new one and save it).
19+
- Go to sketch directory (choose Sketch > Show Sketch Folder).
20+
- Create a directory named `data` and any files you want in the file system there.
21+
- Make sure you have selected a board, port, and closed Serial Monitor.
22+
- Select *Tools > ESP32 Sketch Data Upload* menu item. This should start uploading the files into ESP32 flash file system.
23+
24+
When done, IDE status bar will display SPIFFS Image Uploaded message. Might take a few minutes for large file system sizes.
25+
26+
## Credits and license
27+
28+
- Copyright (c) 2015 Hristo Gochkov (hristo at espressif dot com)
29+
- Licensed under GPL v2 ([text](LICENSE))
30+
- Maintained by Hristo Gochkov (hristo at espressif dot com)
31+
32+
## Issues and suggestions
33+
34+
File issues here on github, or ask your questions on the [esp32.com forum](http://esp32.com).

0 commit comments

Comments
 (0)