Skip to content

Commit b08e038

Browse files
authored
Update README.md
continued edits
1 parent c0ceb31 commit b08e038

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,17 @@
55

66
English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
77

8-
The M5Stack library is included with `#include <M5Stack.h>`, and provides access to the built-in hardware of the M5Stack Basic and Gray controllers through the M5Stack class, referenced as `M5`, including:
8+
The M5Stack library provides access to the built-in hardware of the M5Stack Basic and Gray controllers through the M5Stack class, referenced as `M5`, including:
99
- LCD display via `M5.Lcd`, a customized version of the [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) LCD library, adapted for Basic and Gray. The display resolution is 320x240 supporting 262K colors. Several fonts, graphics primitives, QR code rendering, and PNG/BMP/JPEG support are included.
1010
- Power control via `M5.Power` and the IP5306 power management chip
1111
- Hardware buttons via `M5.BtnA`, `M5.BtnB`, `M5.BtnC`
1212
- Speaker, via `M5.Speaker`, supporting tones, volume control, and basic wave audio playback
1313
- Accelerometer, via `M5.Imu`, `M5.Mpu6886`, or `M5.Sh200Q` (accelerometer type depends on version of Basic/Gray)
1414

15-
Additional include files:
16-
- `M5Faces.h` for access to M5Stack Faces products (EOL)
15+
To use the M5Stack library, `#include "M5Stack.h"` must appear at the top of your sketch.
16+
17+
Additional optional include files:
18+
- `M5Faces.h` for access to M5Stack Faces accessories (EOL)
1719
- `LoRaWan.h`
1820

1921
<img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/gray/gray_01.webp" alt="gray" width="350" height="350"><img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/basic/basic_01.webp" alt="basic" width="350" height="350">
@@ -46,8 +48,6 @@ Additional include files:
4648
* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD
4749
card
4850

49-
* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) - TFT library for the ESP8266 and ESP32 that supports different driver chips
50-
5151
* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack
5252

5353
* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32)

0 commit comments

Comments
 (0)