Skip to content

Commit 89bc31d

Browse files
authored
Update README.md
1 parent 60cba67 commit 89bc31d

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
# 🚫 Deprecated — Use M5GFX & M5Unified
2+
3+
- **M5GFX**
4+
High-performance, lightweight graphics and display driver library for M5 devices.
5+
<https://github.com/m5stack/M5GFX>
6+
7+
- **M5Unified**
8+
Unified base library for M5 devices (IO/peripherals, power management, audio, etc.).
9+
<https://github.com/m5stack/M5Unified>
10+
111
# M5Stack Library
212

313
[![Arduino Lint](https://github.com/m5stack/M5Stack/actions/workflows/Arduino-Lint-Check.yml/badge.svg)](https://github.com/m5stack/M5Stack/actions/workflows/Arduino-Lint-Check.yml)
@@ -7,9 +17,6 @@ English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_starte
717

818
The M5Stack library provides access to the built-in hardware of the M5Stack Core (including Basic and Gray) controllers.
919

10-
## Recommendation
11-
**<span style="font-size: larger">This library is not recommended for new projects, nor for projects using M5Stack products other than _Basic_ and _Gray_. See [M5Unified](https://github.com/M5Stack/M5Unified) and [M5GFX](https://github.com/M5Stack/M5GFX) for libraries that are more up-to-date and with support for many newer M5Stack products.</span>**
12-
1320
## Usage
1421
This library's functionality is available through the M5Stack class, referenced as `M5`, including:
1522
- 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.

0 commit comments

Comments
 (0)