From df5cc7fb39f2003994ec907f57c0fd857a6d838e Mon Sep 17 00:00:00 2001 From: Charles Taylor Date: Sun, 6 Dec 2020 23:18:35 -0800 Subject: [PATCH] Separate commit for README changes. --- README.md | 35 ++++------------------------------- 1 file changed, 4 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index ae1f080..d08eb9e 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,7 @@ -# Arduino ESP32 filesystem uploader +# Arduino ESP32 filesystem uploader + S2 -Arduino plugin which packs sketch data folder into SPIFFS filesystem image, -and uploads the image to ESP32 flash memory. +This is a fork of the original repo found [here](https://github.com/me-no-dev/arduino-esp32fs-plugin). -## Installation +Nothing has changed except that support for the ESP32 S2 modules (and a few others) has been added. -- Make sure you use one of the supported versions of Arduino IDE and have ESP32 core installed. -- Download the tool archive from [releases page](https://github.com/me-no-dev/arduino-esp32fs-plugin/releases/latest). -- In your Arduino sketchbook directory, create tools directory if it doesn't exist yet. -- Unpack the tool into tools directory (the path will look like ```/Arduino/tools/ESP32FS/tool/esp32fs.jar```). -- Restart Arduino IDE. - -On the OS X create the tools directory in ~/Documents/Arduino/ and unpack the files there - -## Usage - -- Open a sketch (or create a new one and save it). -- Go to sketch directory (choose Sketch > Show Sketch Folder). -- Create a directory named `data` and any files you want in the file system there. -- Make sure you have selected a board, port, and closed Serial Monitor. -- Select *Tools > ESP32 Sketch Data Upload* menu item. This should start uploading the files into ESP32 flash file system. - - When done, IDE status bar will display SPIFFS Image Uploaded message. Might take a few minutes for large file system sizes. - -## Credits and license - -- Copyright (c) 2015 Hristo Gochkov (hristo at espressif dot com) -- Licensed under GPL v2 ([text](LICENSE)) -- Maintained by Hristo Gochkov (hristo at espressif dot com) - -## Issues and suggestions - -File issues here on github, or ask your questions on the [esp32.com forum](http://esp32.com). +A ready-to-go release is available [here](https://github.com/etherfi/arduino-esp32fs-plugin-esp32s2/releases).