docs: add collapsed Ubuntu dependency and build notes in all READMEs
Signed-off-by: Asklv <boironic@gmail.com>
This commit is contained in:
31
README.md
31
README.md
@@ -58,6 +58,37 @@ cd mimiclaw
|
|||||||
# https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32s3/get-started/
|
# https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32s3/get-started/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
##### Ubuntu Notes
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Ubuntu dependency versions and build steps (collapsed by default)</summary>
|
||||||
|
|
||||||
|
Recommended baseline:
|
||||||
|
|
||||||
|
- Ubuntu 22.04/24.04
|
||||||
|
- Python >= 3.10
|
||||||
|
- CMake >= 3.16
|
||||||
|
- Ninja >= 1.10
|
||||||
|
- Git >= 2.34
|
||||||
|
- flex >= 2.6
|
||||||
|
- bison >= 3.8
|
||||||
|
- gperf >= 3.1
|
||||||
|
- dfu-util >= 0.11
|
||||||
|
- `libusb-1.0-0`, `libffi-dev`, `libssl-dev`
|
||||||
|
|
||||||
|
Install and build on Ubuntu:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y git wget flex bison gperf python3 python3-pip python3-venv \
|
||||||
|
cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
|
||||||
|
|
||||||
|
./scripts/setup_idf_ubuntu.sh
|
||||||
|
./scripts/build_ubuntu.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
### Configure
|
### Configure
|
||||||
|
|
||||||
MimiClaw uses a **two-layer config** system: build-time defaults in `mimi_secrets.h`, with runtime overrides via the serial CLI. CLI values are stored in NVS flash and take priority over build-time values.
|
MimiClaw uses a **two-layer config** system: build-time defaults in `mimi_secrets.h`, with runtime overrides via the serial CLI. CLI values are stored in NVS flash and take priority over build-time values.
|
||||||
|
|||||||
31
README_CN.md
31
README_CN.md
@@ -58,6 +58,37 @@ cd mimiclaw
|
|||||||
# https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32s3/get-started/
|
# https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32s3/get-started/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
##### Ubuntu 备注
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Ubuntu 依赖版本与安装编译步骤(默认折叠)</summary>
|
||||||
|
|
||||||
|
建议基线:
|
||||||
|
|
||||||
|
- Ubuntu 22.04/24.04
|
||||||
|
- Python >= 3.10
|
||||||
|
- CMake >= 3.16
|
||||||
|
- Ninja >= 1.10
|
||||||
|
- Git >= 2.34
|
||||||
|
- flex >= 2.6
|
||||||
|
- bison >= 3.8
|
||||||
|
- gperf >= 3.1
|
||||||
|
- dfu-util >= 0.11
|
||||||
|
- `libusb-1.0-0`、`libffi-dev`、`libssl-dev`
|
||||||
|
|
||||||
|
Ubuntu 安装与构建:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y git wget flex bison gperf python3 python3-pip python3-venv \
|
||||||
|
cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
|
||||||
|
|
||||||
|
./scripts/setup_idf_ubuntu.sh
|
||||||
|
./scripts/build_ubuntu.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
### 配置
|
### 配置
|
||||||
|
|
||||||
MimiClaw 使用**两层配置**:`mimi_secrets.h` 提供编译时默认值,串口 CLI 可在运行时覆盖。CLI 设置的值存在 NVS Flash 中,优先级高于编译时值。
|
MimiClaw 使用**两层配置**:`mimi_secrets.h` 提供编译时默认值,串口 CLI 可在运行时覆盖。CLI 设置的值存在 NVS Flash 中,优先级高于编译时值。
|
||||||
|
|||||||
31
README_JA.md
31
README_JA.md
@@ -58,6 +58,37 @@ cd mimiclaw
|
|||||||
# https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32s3/get-started/
|
# https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32s3/get-started/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
##### Ubuntu メモ
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Ubuntu の依存バージョンとインストール/ビルド手順(デフォルト折りたたみ)</summary>
|
||||||
|
|
||||||
|
推奨ベースライン:
|
||||||
|
|
||||||
|
- Ubuntu 22.04/24.04
|
||||||
|
- Python >= 3.10
|
||||||
|
- CMake >= 3.16
|
||||||
|
- Ninja >= 1.10
|
||||||
|
- Git >= 2.34
|
||||||
|
- flex >= 2.6
|
||||||
|
- bison >= 3.8
|
||||||
|
- gperf >= 3.1
|
||||||
|
- dfu-util >= 0.11
|
||||||
|
- `libusb-1.0-0`, `libffi-dev`, `libssl-dev`
|
||||||
|
|
||||||
|
Ubuntu でのインストールとビルド:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y git wget flex bison gperf python3 python3-pip python3-venv \
|
||||||
|
cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
|
||||||
|
|
||||||
|
./scripts/setup_idf_ubuntu.sh
|
||||||
|
./scripts/build_ubuntu.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
### 設定
|
### 設定
|
||||||
|
|
||||||
MimiClawは**2層設定**を採用しています:`mimi_secrets.h`でビルド時のデフォルト値を設定し、シリアルCLIで実行時にオーバーライドできます。CLI設定値はNVS Flashに保存され、ビルド時の値より優先されます。
|
MimiClawは**2層設定**を採用しています:`mimi_secrets.h`でビルド時のデフォルト値を設定し、シリアルCLIで実行時にオーバーライドできます。CLI設定値はNVS Flashに保存され、ビルド時の値より優先されます。
|
||||||
|
|||||||
Reference in New Issue
Block a user