Skip to content

Commit

Permalink
READMEとコントリビュートに関するドキュメントの修正
Browse files Browse the repository at this point in the history
  • Loading branch information
KuraZuzu committed May 9, 2024
1 parent b94c707 commit a00f218
Show file tree
Hide file tree
Showing 178 changed files with 63 additions and 674,157 deletions.
32 changes: 23 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
* I welcome pull requests of all kinds
* Add original accessories for Stack-chan
* Stability/Extensibility improvement of schematics and board layout
* New examples(mods) on top of firmware
* Add development instruction
* Fix typo
* There are no restrictions or rules regarding the creation and submission of pull requests at this time.
* CI process for testing firmware builds is under construction.
* Take it easy and stay healthy. Thank you very much.
本リポジトリへのコントリビュート方法について記載しています。

Issues

リポジトリの品質向上にご協力頂きありがとうございます。

Issueの作成を簡単にするテンプレートを用意しているので活用してください。

Pull Requests

Pull Requestの作成ありがとうございます。 提出したPull Request(PR)には次のルールが適用されます。

PRの内容には本リポジトリのライセンス(LICENSEとREADME.mdに記載されています)が適用されます
PRはrt-netのメンバーによるレビューを経てからマージされます
すべてのPRがマージされるわけではなく、希望に添えない場合もありますのでご容赦ください
リポジトリにテストが設定されている場合はできるだけテストを通してください
何かしらの理由(テストに間違いがある場合など)でテストを通さずPRを出す場合はその旨をPRに記載してください
マージする際にはPR内の全コミットが1つのコミットにsquashされます
コミットをスカッシュしてマージする | GitHub Docs
1つのPRでリクエストする変更はできるだけシンプルにしてください
異なる内容の変更を含む場合はPRを分割してください
例えば、複数の機能追加したり、機能追加とリファクタリングを同時にする場合はそれぞれ別々のPRとしてください
squashマージしても履歴を辿りやすくするためです
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,30 @@
# Stack-chan
# Stack-chan RT ver.

[![Build Stack-chan Firmware](https://github.com/meganetaaan/stack-chan/actions/workflows/build.yml/badge.svg)](https://github.com/meganetaaan/stack-chan/actions/workflows/build.yml)
[![Discord server invitation](https://dcbadge.vercel.app/api/server/eGhd9adnBm)](https://discord.gg/eGhd9adnBm)

[日本語](./README_ja.md)

![stackchan](./docs/images/stackchan.gif)
![stackchan](./docs/images/stack-chan_main_2400x2400_350dpi_rgb.jpg)

Stack-chan is a JavaScript-driven M5Stack-embedded super-kawaii robot.
This is the repository for Stack-chan RT ver.

* Video (with English subtitles): https://youtu.be/fZb_mF08xV0
* Official hashtag: [`#stackchan` | `#スタックチャン` (JP)](https://twitter.com/search?q=%23stackchan%20OR%20%23%EF%BD%BD%EF%BE%80%EF%BD%AF%EF%BD%B8%EF%BE%81%EF%BD%AC%EF%BE%9D).


Stack-chan is a super cute, palm-sized communication robot developed and released in JavaScript by [Shinya Ishikawa](https://twitter.com/stack_chan).
* Project page: https://github.com/meganetaaan/stack-chan
* Video (with English subtitles): https://youtu.be/fZb_mF08xV0

<br>

The version includes the following changes:

* We are fixing the firmware version and the dependent Moddable SDK version to [4.1](https://github.com/Moddable-OpenSource/moddable/releases/tag/4.1)
* Some modifications have been made to the circuit diagram and the board.
* The DYNAMIXEL XL330-M288-T servo motor is adopted.
* The body is manufactured by injection molding.

## Features

* :neutral_face: Show cute face
Expand All @@ -25,31 +38,21 @@ Stack-chan is a JavaScript-driven M5Stack-embedded super-kawaii robot.

## Contents

This repository includes all the component of the robot.
This repository includes the following contents.

* __firmware__ : Source codes of the firmware.
* __case__ : Stereolithography(STL) of the case.
* __schematics__ : Schematics and board layout data.

## Installation

### Assemble board

* See [schematics/README.md](./schematics/README.md) and [case/README.md](./case/README.md)
* OR You can get a pre-assembled module(COMING SOON)

### Flash firmware to M5Stack

* See [firmware/README.md](./firmware/README.md)

## Contribution

__Feature requests/Bug reports__ are extremely welcome! See [issues](https://github.com/meganetaaan/stack-chan/issues) page to post some.

__Wanna be a sponsor__? It would be my great honor. please visit my [sponsor](https://github.com/sponsors/meganetaaan/) page.
We accept __feature requests / bug reports__ through the [issues](https://github.com/rt-net/stack-chan/issues) page.

## License

Resources of this repository are distributed under Apache version 2.0 license.
See [LICENSE](./LICENSE).

37 changes: 21 additions & 16 deletions README_ja.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,32 @@
# スタックチャン(Stack-chan)
# スタックチャン アールティver.(Stack-chan RT ver.)

[![ファームウェアのビルド](https://github.com/meganetaaan/stack-chan/actions/workflows/build.yml/badge.svg)](https://github.com/meganetaaan/stack-chan/actions/workflows/build.yml)
[![Discordサーバへの招待](https://dcbadge.vercel.app/api/server/eGhd9adnBm)](https://discord.gg/eGhd9adnBm)

[English](./README.md)

![stackchan](./docs/images/stackchan.gif)
![stackchan](./docs/images/stack-chan_main_2400x2400_350dpi_rgb.jpg)

スタックチャンはM5Stackで作られた、JavaScriptで動くスーパーカワイイロボットです
スタックチャン アールティver. のリポジトリです

* 動画: https://youtu.be/fZb_mF08xV0
* 公式ハッシュタグ: [`#stackchan` | `#スタックチャン` (JP)](https://twitter.com/search?q=%23stackchan%20OR%20%23%EF%BD%BD%EF%BE%80%EF%BD%AF%EF%BD%B8%EF%BE%81%EF%BD%AC%EF%BE%9D).


スタックチャンは[ししかわ](https://twitter.com/stack_chan)がJavaScriptで開発し、公開している、手乗りサイズのスーパーカワイイコミュニケーションロボットです。
* 作品ページ:https://github.com/meganetaaan/stack-chan
* 動画: https://youtu.be/fZb_mF08xV0

<br>

スタックチャン アールティver. では以下の変更が加えられています。

* ファームウェアのバージョンと依存するModdable SDKのバージョンを[4.1](https://github.com/Moddable-OpenSource/moddable/releases/tag/4.1)に固定しています
* 回路図・基板を一部変更しています
* サーボモータに DYNAMIXEL XL330-M288-T を採用しています
* 本体を射出成形で製造しています



## 機能

* :neutral_face: かわいい顔
Expand All @@ -25,31 +40,21 @@

## コンテンツ

本リポジトリはロボットのあらゆる構成要素を含みます
本リポジトリは以下の構成要素を含みます

* __firmware__ : ファームウェアのソースコード
* __case__ : ケースSTLファイル
* __schematics__ : 回路図と基板レイアウト

## 製作方法

### モジュールを組み立てる

* [schematics/README_ja.md](./schematics/README_ja.md)[case/README_ja.md](./case/README_ja.md)を参照ください。
* または組み立て済みのモジュールを入手してください(近日公開予定)。

### ファームウェアをM5Stackに書き込む

* [firmware/README_ja.md](./firmware/README_ja.md)を参照ください。

## コントリビューション

__機能追加のリクエスト/バグ報告__ を歓迎します![issues](https://github.com/meganetaaan/stack-chan/issues)のページから投稿してください。

__スポンサーになりたいですか__?光栄です![sponsor](https://github.com/sponsors/meganetaaan/)のページを参照ください。
機能追加のリクエスト/バグ報告は[issues](https://github.com/rt-net/stack-chan/issues)のページから投稿を受け付けています。

## ライセンス

このリポジトリ配下のリソースはApache version 2.0ライセンスのもと配布されています。
[LICENSE](./LICENSE)を確認してください。

150 changes: 0 additions & 150 deletions case/README.md

This file was deleted.

Loading

0 comments on commit a00f218

Please sign in to comment.