Skip to content

Commit 39e9fa8

Browse files
committed
[update] README
1 parent 99a2492 commit 39e9fa8

File tree

2 files changed

+43
-4
lines changed

2 files changed

+43
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* [SystemRequirements](#SystemRequirements)
1616
* [Compile](#Compile)
1717
* [Installation](#Installation)
18+
* [OnlineInstallation](#OnlineInstallation)
1819
* [Upgrade](#Upgrade)
1920
* [Run](#Run)
2021
* [Configuration](#Configuration)
@@ -43,7 +44,7 @@ Main working modes of the StackFlow voice assistant:
4344
After startup, KWS, ASR, LLM, TTS, and AUDIO are configured to work collaboratively. When KWS detects a keyword in the audio obtained from the AUDIO unit, it sends a wake-up signal. At this point, ASR starts working, recognizing the audio data from AUDIO and publishing the results to its output channel. Once LLM receives the text data converted by ASR, it begins reasoning and publishes the results to its output channel. TTS, upon receiving the results from LLM, starts voice synthesis and plays the synthesized audio data according to the configuration.
4445

4546

46-
## Demo
47+
## Demo ##
4748
- [StackFlow continuous speech recognition](./projects/llm_framework/README.md)
4849
- [StackFlow LLM large model awakening dialogue](./projects/llm_framework/README.md)
4950
- [StackFlow TTS voice synthesis playback](./projects/llm_framework/README.md)
@@ -95,7 +96,26 @@ dpkg -i ./llm-xxx_1.4-m5stack1_arm64.deb
9596
# Note the installation order of lib-llm_1.4-m5stack1_arm64.deb and llm-sys_1.4-m5stack1_arm64.deb. The installation order of other llm units and model packages is not required.
9697
```
9798

98-
## Upgrade
99+
## OnlineInstallation ##
100+
Online installation requires an active internet connection. Please ensure network connectivity. The model package is relatively large, so install and use it as needed.
101+
102+
```bash
103+
# Add apt key and source
104+
wget -qO /etc/apt/keyrings/StackFlow.gpg https://repo.llm.m5stack.com/m5stack-apt-repo/key/StackFlow.gpg
105+
echo 'deb [arch=arm64 signed-by=/etc/apt/keyrings/StackFlow.gpg] https://repo.llm.m5stack.com/m5stack-apt-repo jammy ax630c' > /etc/apt/sources.list.d/StackFlow.list
106+
# Update apt sources
107+
apt update
108+
# First install dynamic library dependencies
109+
apt install lib-llm
110+
# Then install the main llm-sys unit
111+
apt install llm-sys
112+
# Install other llm units
113+
apt install llm-xxx
114+
# Install the model package
115+
apt install llm-model-xxx
116+
```
117+
118+
## Upgrade ##
99119
When upgrading, you can either upgrade the AI unit individually or upgrade the entire StackFlow framework.
100120
When upgrading a single unit, you can upgrade via an SD card or manually install using the `dpkg` command. It's important to note that for minor version packages, you can install the upgrade package individually, but for major version upgrades, all llm units must be installed completely.
101121
Command line upgrade package:
@@ -122,12 +142,12 @@ Both types of configuration files use the JSON format and are located in multipl
122142
## Interface ##
123143
StackFlow can be accessed via UART and TCP ports. The default baud rate for the UART port is 115200, and the default port for the TCP port is 10001. Parameters can be modified through configuration files.
124144

125-
## Contribution
145+
## Contribution ##
126146

127147
* If you like this project, please give it a star first;
128148
* To report a bug, please go to the [issue page](https://github.com/m5stack/StackFlow/issues);
129149
* If you want to contribute code, feel free to fork it and then submit a pull request;
130150

131-
## Star History
151+
## Star History ##
132152

133153
[![Star History Chart](https://api.star-history.com/svg?repos=m5stack/StackFlow&type=Date)](https://star-history.com/#m5stack/StackFlow&Date)

README_zh.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
* [环境要求](#环境要求)
1818
* [编译](#编译)
1919
* [安装](#安装)
20+
* [在线安装](#在线安装)
2021
* [升级](#升级)
2122
* [运行](#运行)
2223
* [配置](#配置)
@@ -97,6 +98,24 @@ dpkg -i ./llm-xxx_1.4-m5stack1_arm64.deb
9798
# 注意 lib-llm_1.4-m5stack1_arm64.deb 和 llm-sys_1.4-m5stack1_arm64.deb 的安装顺序,其他 llm 单元和模型包的安装顺序没有要求。
9899
```
99100

101+
## 在线安装 ##
102+
在线安装需要联网,请保持网络畅通,模型包较大,请酌情安装使用。
103+
```bash
104+
# 添加 apt 密钥和源
105+
wget -qO /etc/apt/keyrings/StackFlow.gpg https://repo.llm.m5stack.com/m5stack-apt-repo/key/StackFlow.gpg
106+
echo 'deb [arch=arm64 signed-by=/etc/apt/keyrings/StackFlow.gpg] https://repo.llm.m5stack.com/m5stack-apt-repo jammy ax630c' > /etc/apt/sources.list.d/StackFlow.list
107+
# 更新 apt 源
108+
apt update
109+
# 首先安装动态库依赖
110+
apt install lib-llm
111+
# 然后安装 llm-sys 主单元
112+
apt install llm-sys
113+
# 安装其他 llm 单元
114+
apt install llm-xxx
115+
# 安装模型包
116+
apt install llm-model-xxx
117+
```
118+
100119
## 升级
101120
升级时可单独升级 AI 单元,或者升级整个 StackFlow 框架。
102121
升级单个单元时可通过 SD 卡升级或者手动 `dpkg` 命令进行安装。需要注意的时在小版本的包中,可以单独安装升级包,但是大版本升级时,必须安装完所有的 llm 单元。

0 commit comments

Comments
 (0)