Skip to content

Commit ad30b3d

Browse files
authored
Merge pull request #10 from mROS-base/readme_202309
improve README
2 parents dd8243d + afb44e6 commit ad30b3d

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

Readme.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Please also check [mros2 repository](https://github.com/mROS-base/mros2) for mor
1111
- M5Stack Basic
1212
- M5Stack Core2
1313
- M5Stack CoreS3
14+
- XIAO ESP32C3 (see [#7](https://github.com/mROS-base/mros2-esp32/issues/7))
1415

1516
# Quickstart by this repository itself
1617

@@ -20,6 +21,8 @@ https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html
2021

2122
After install esp-idf, you need to install jinja2 library in esp-idf environment.
2223

24+
Currently, we checked the operation of basic sapmles with esp-idf v5.1.1.
25+
2326
## git clone and settings
2427
```
2528
git clone --recursive https://github.com/mROS-base/mros2-esp32.git
@@ -49,9 +52,9 @@ Currently, the following examples are available.
4952
- sub_pose
5053
- sub_uint16
5154
- m5stack_sample
52-
53-
M5Stack_sample project needs [M5Unified](https://github.com/m5stack/M5Unified) and [M5GFX](https://github.com/m5stack/M5GFX) libraries.
54-
Git clone these libraries to ```common/``` directory.
55+
- M5Stack_sample project needs [M5Unified](https://github.com/m5stack/M5Unified) and [M5GFX](https://github.com/m5stack/M5GFX) libraries.
56+
Git clone these libraries to ```common/``` directory.
57+
Note that you need to use ESP-IDF v4.4.4 to try this sample due to the compatibility of these libraries.
5558

5659

5760
The following examples are under development. untested.
@@ -96,3 +99,10 @@ clone this repository to ```components``` directory in your project.
9699
mros2 needs network connection and setting of IP address.
97100
Please see [Wifi connection example](workspace/common/wifi).
98101
IP address setting find in upper section [Change IP address](#change-ip-address).
102+
103+
# Awesome resources!
104+
105+
The following are trial reports written by third-party users. We deeply appreciate your contributions! Of course, PR for adding your reports/articles, example of works are very welcome!!
106+
107+
- [@tasada038](https://github.com/tasada038): 「[mros2-esp32とM5Stackでサンプルプログラムを試す](https://zenn.dev/tasada038/articles/fdbf3e5ff7cd01)
108+
- [@Ar-Ray-code](https://github.com/Ar-Ray-code): 「[mros2-esp32をDocker内でビルドする](https://ar-ray.hatenablog.com/entry/2023/06/10/235333)

0 commit comments

Comments
 (0)