Stack Chan

1# Stack-chan
2 
3[![Build Stack-chan Firmware](https://github.com/stack-chan/stack-chan/actions/workflows/build.yml/badge.svg)](https://github.com/stack-chan/stack-chan/actions/workflows/build.yml)
4[![Discord server invitation](https://dcbadge.vercel.app/api/server/eGhd9adnBm)](https://discord.gg/eGhd9adnBm)
5 
6[日本語](./README_ja.md)
7 
8![stackchan](./docs/images/stackchan.gif)
9 
10Stack-chan is a JavaScript-driven M5Stack-embedded super-kawaii robot.
11 
12* Video (with English subtitles): https://youtu.be/fZb_mF08xV0
13* 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).
14 
15## Features
16 
17* :neutral_face:     Show cute face
18* :smile:            Expression(Happy, Angry, Sad etc.)
19* :smiley_cat:       Customize face
20* :eyes:             Glance/stare/gaze
21* :speech_balloon:   Say things
22* :bulb:             Addon M5Units
23* :cyclone:          Drive Serial(TTL)/PWM servos
24* :game_die:         Make applications on your own
25 
26## Contents
27 
28This repository includes all the component of the robot.
29 
30* __firmware__ : Source codes of the firmware.
31* __case__ : Stereolithography(STL) of the case.
32* __schematics__ : Schematics and board layout data.
33 
34## Installation
35 
36### Assemble board
37 
38* See [schematics/README.md](./schematics/README.md) and [case/README.md](./case/README.md)
39* OR You can get a pre-assembled module(COMING SOON)
40 
41### Flash firmware to M5Stack
42 
43* See [firmware/README.md](./firmware/README.md)
44 
45## Contribution
46 
47__Feature requests/Bug reports__ are extremely welcome! See [issues](https://github.com/stack-chan/stack-chan/issues) page to post some.
48 
49__Wanna be a sponsor__? It would be my great honor. please visit my [sponsor](https://github.com/sponsors/meganetaaan/) page.
50 
51## License
52 
53Resources of this repository are distributed under Apache version 2.0 license.
54See [LICENSE](./LICENSE).
55 
56## BibTeX
57 
58```bibtex
59@misc{stackchan,
60  author       = {Shinya Ishikawa and the Stack-chan community},
61  title        = {Stack-chan: A JavaScript-driven Super-kawaii Robot},
62  year         = {2021},
63  howpublished = {\url{https://github.com/stack-chan/stack-chan}},
64  note         = {Open-source hardware and software.},
65}
66```
67