Skip to content

Commit 3afb04f

Browse files
committed
More readme fixes
1 parent d7e863e commit 3afb04f

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ git clone --recursive https://github.com/mruby-esp32/mruby-esp32.git
1919

2020
The makefile configuration is in `main/component.mk`. The entry point source
2121
file is `mruby_main.c`. Once that starts, it looks for `storage/main.rb` and runs it in mruby.
22-
You can change the expected filename `mruby_main.c`, or simply save your scripts as `main.rb`
22+
You can change the expected filename in `mruby_main.c`, or simply save your scripts as `main.rb`
2323
inside the `storage` subfolder.
2424

2525
### First Build
@@ -80,11 +80,33 @@ All gems are enabled by default, so you can try out the examples, but it's a goo
8080

8181
## Hardware
8282

83-
This has been tested on:
83+
Everything works on:
8484
- Original ESP32: `idf.py set-target esp32`
85+
86+
Everything except gpio gem works on:
8587
- ESP32-S2: `idf.py set-target esp32s2`
8688
- ESP32-S3: `idf.py set-target esp32s3`
8789

8890
If you followed the IDF installation instructions correctly for your chip,
89-
you can switch the project to target it with the corresponding command above.
90-
Make sure to `fullclean` and `build` after switching.
91+
you can switch the project target with the corresponding command above.
92+
93+
You will probably not be able to build again, until the project partition table is reset to `partitions.csv`. To do this:
94+
95+
```
96+
idf.py menuconfig
97+
# Partition Table -> Partition Table (1st option) -> Custom partition Table CSV (Last options)
98+
# Enter to select. Q to exit. Y to save
99+
```
100+
101+
## Troubleshooting
102+
103+
The following files and folders are safe to delete when trying to solve build issues:
104+
- `build`
105+
- `components/mruby_component/build`
106+
- `components/mruby_component/esp32_build_config.rb.lock`
107+
- `managed_components`
108+
- `dependencies.lock`
109+
110+
This project uses [littlefs](https://github.com/littlefs-project/littlefs) through IDF component
111+
manager. If you see errors about files on disk changing, try deleting the last 2 items on this list.
112+

0 commit comments

Comments
 (0)