Skip to content

Commit

Permalink
📝 docs: Update README
Browse files Browse the repository at this point in the history
- Add a link to the community forum post about CubeFX
- Improve the description of CubeFX
- Add a tip for connecting to the AP
- Update the demo video link
- Update the Chinese README with the same changes
  • Loading branch information
Cp0204 committed Jul 22, 2024
1 parent 24d0efb commit 3aa89ee
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# CubeFX

Inject colorful lighting into your ZimaCube!
Inject Colorful lighting into your ZimaCube!

CubeFX is a **third-party** open-source lighting control system designed for the ZimaCube, based on the ESP32-C3 and WS2812B LED strips. It allows you to customize lighting effects, colors, and speed, and control them through a web page or buttons.
CubeFX is a **third-party open-source lighting control system** designed for the ZimaCube, based on the ESP32-C3 and WS2812B LED strips. It allows you to customize lighting effects, colors, and speed, and control them through a web page or buttons.

[![GitHub release](https://img.shields.io/github/v/release/Cp0204/CubeFX.svg)](https://github.com/Cp0204/CubeFX/releases/latest) [![GitHub license](https://img.shields.io/github/license/Cp0204/CubeFX.svg)](https://github.com/Cp0204/CubeFX/blob/main/LICENSE)

[![Demo](https://img.youtube.com/vi/K5UVmzoG0bY/0.jpg)](https://www.youtube.com/watch?v=K5UVmzoG0bY)
[![Demo](https://img.youtube.com/vi/K5UVmzoG0bY/mqdefault.jpg)](https://www.youtube.com/watch?v=K5UVmzoG0bY)

[Learn more](https://icewhale.community/t/unleash-the-zimacube-introducing-cubefx-the-open-source-led-strip-firmware/3372)

## Features

Expand Down Expand Up @@ -38,7 +40,10 @@ CubeFX is a **third-party** open-source lighting control system designed for the

Connect to the AP and open http://172.16.1.1/post

Or use other software to POST data to `http://172.16.1.1/post` in the following format:
> [!TIP]
> It is recommended to use a cell phone to connect as close as possible to the 7th-Bay, because its signal is really weak.
Or use other program to **POST** data to `http://172.16.1.1/post` in the following format:

```json
{
Expand Down
11 changes: 8 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

为你的 ZimaCube 注入多彩灯光!

CubeFX 是一个为 ZimaCube 设计的**第三方**开源灯光控制系统,基于 ESP32-C3 和 WS2812B 灯带。它可以让你自定义灯光效果、颜色和速度,并通过 Web 页面或按键进行控制。
CubeFX 是一个为 ZimaCube 设计的**第三方开源灯光控制系统**,基于 ESP32-C3 和 WS2812B 灯带。它可以让你自定义灯光效果、颜色和速度,并通过 Web 页面或按键进行控制。

[![GitHub release](https://img.shields.io/github/v/release/Cp0204/CubeFX.svg)](https://github.com/Cp0204/CubeFX/releases/latest) [![GitHub license](https://img.shields.io/github/license/Cp0204/CubeFX.svg)](https://github.com/Cp0204/CubeFX/blob/main/LICENSE)

[![Demo](https://img.youtube.com/vi/K5UVmzoG0bY/0.jpg)](https://www.youtube.com/watch?v=K5UVmzoG0bY)
[![Demo](https://img.youtube.com/vi/K5UVmzoG0bY/mqdefault.jpg)](https://www.youtube.com/watch?v=K5UVmzoG0bY)

[了解更多](https://icewhale.community/t/unleash-the-zimacube-introducing-cubefx-the-open-source-led-strip-firmware/3372)

## 特性

Expand Down Expand Up @@ -38,7 +40,10 @@ CubeFX 是一个为 ZimaCube 设计的**第三方**开源灯光控制系统,

连接热点打开 http://172.16.1.1/post

或使用其它软件 POST 数据到 `http://172.16.1.1/post` ,数据格式如下:
> [!TIP]
> 建议用手机尽量靠近第七盘连接,因为它的信号相当弱。
或使用其它程序 **POST** 数据到 `http://172.16.1.1/post` ,数据格式如下:

```json
{
Expand Down

0 comments on commit 3aa89ee

Please sign in to comment.