Skip to content

Commit 657df52

Browse files
committed
fix README_en.md
1 parent 377a720 commit 657df52

File tree

2 files changed

+38
-19
lines changed

2 files changed

+38
-19
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ lib_ldf_mode = deep ; これを忘れる
5050
https://github.com/stack-chan/stack-chan
5151

5252
# Credit
53+
5354
- [meganetaaan](https://github.com/meganetaaan)
5455
- [lovyan03](https://github.com/lovyan03/LovyanGFX)
5556
- [robo8080](https://github.com/robo8080)

README_en.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,48 @@ Stack Chan Library for ArduinoFramework
33

44
[日本語](./README.md) | English
55

6-
# 使い方
6+
# Function
7+
- Read configuration file functionality<br>Configuration files described below can be read to change settings. <br>Include Stackchan_system_config.h.
8+
- Servo control function<br>Currently three types of servos can be switched and controlled by settings. <br>Include Stackchan_servo.h.
9+
- PWM<br>PWM servos such as SG90
10+
- SCS<br>Feetech SCS0009 serial servo
11+
- DYN_XL330<br>Dynamixel XL330-M288-T
12+
- Notice:Unimplemented Stack-chan_Takao_Base status monitoring<br>We plan to implement useful functions for using Stack-chan_Takao_Base.
713

8-
platformio.iniのlib_depsに下記の記述を追加してください。
14+
# Usage
15+
- [Basic](./examples/Basic/) See here how to load parameters.
16+
- [stack-chan_tester](https://github.com/mongonta0716/stack-chan-tester) Usage Servo,etc.
917

10-
```
11-
lib_deps =
12-
stack-chan/stackchan-arduino@^0.0.1
13-
lib_ldf_mode = deep ; これを忘れるとリンクエラーになります。
14-
```
18+
# Configuration files
19+
The settings are commented in detail in each file; please write them in YAML format. <br>* YAML is used because it is convenient to describe comments.
20+
- [SC_BasicConfig.yaml](./data/yaml/SC_BasicConfig.yaml)<br>This file collects the basic parameters necessary to start the stack chan.
21+
- [SC_SecConfig.yaml](./data/yaml/SC_SecConfig.yaml)<br>Configuration file for personal information. (WiFi, APIKey, etc.)
22+
- [SC_ExConfig.yaml](./data/yaml/SC_ExConfig.yaml)<br>This is used when you want to add settings on the application side. The usage is [Folder](./examples/Basic/) source for usage.
1523

16-
# 機能
17-
- 設定ファイルの読み込み機能<br>後述の設定ファイルを読み込んで設定を変更することができます。<br>Stackchan_system_config.hをincludeします。
18-
- サーボのコントロール機能<br>現在3種類のサーボを設定で切り替えてコントロールすることが可能です。<br>Stackchan_servo.hをincludeします。
19-
- PWM<br>SG90等のPWMサーボ
20-
- SCS<br>Feetech SCS0009 シリアルサーボ
21-
- DYN_XL330<br>Dynamixel XL330-M288-T
22-
- 【未実装】Stack-chan_Takao_Baseの状態監視<br>Stack-chan_Takao_Baseを使うための便利な機能を実装予定です。
24+
# Required Library
25+
26+
For a detailed version, see [library.json](./library.json). If you use ArduinoIDE, please make sure the version is up-to-date or you may not be able to build or use PlatformIO.
27+
- [M5Unified](https://github.com/m5stack/M5Unified)
28+
- [ESP32Servo](https://github.com/madhephaestus/ESP32Servo)
29+
- [ServoEasing](https://github.com/ArminJo/ServoEasing)
30+
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson)
31+
- [Dynamixel2Arduino](https://github.com/ROBOTIS-GIT/Dynamixel2Arduino)
32+
- [YAMLDuino](https://github.com/tobozo/YAMLDuino)
33+
- [SCServo](https://github.com/mongonta0716/SCServo)
34+
35+
36+
# About Stack Chan
37+
38+
Stackchang is an open source project published by [Shishikawasan](https://github.com/stack-chan).
39+
40+
https://github.com/stack-chan/stack-chan
2341

42+
# Credit
2443

25-
# 設定ファイル
26-
設定内容は各ファイルに詳しくコメントしています。
27-
- [SC_BasicConfig.yaml](./data/yaml/SC_BasicConfig.yaml)<br>スタックチャンを起動するために必要な基本的なパラメータを集めています。
28-
- [SC_SecConfig.yaml](./data/yaml/SC_SecConfig.yaml)<br>個人情報用の設定ファイルです。(WiFiやAPIKey等)
29-
- [SC_ExConfig.yaml](./data/yaml/SC_ExConfig.yaml)<br>アプリケーション側で、設定を追加したいときに使用します。使い方は[Folder](./examples/Basic/)のソースを参照してください。
44+
- [meganetaaan](https://github.com/meganetaaan)
45+
- [lovyan03](https://github.com/lovyan03/LovyanGFX)
46+
- [robo8080](https://github.com/robo8080)
47+
- [tobozo](https://github.com/tobozo)
3048

3149
# LICENCE
3250

0 commit comments

Comments
 (0)