Update README.md

ShotaAk · Jul 3, 2020 · ffcd813 · ffcd813
1 parent 20a48b8
commit ffcd813
Showing 1 changed file with 35 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,41 @@
 
 ESP32を搭載したマイクロマウスのプログラム
 
+# Requirements
+
+- Especial (Optional)
+  - 私が作成したオリジナルマウスがあると、本プログラムの全機能を動かせます
+- ESP32-WROOM-32D
+- ESP-IDF v3.3.0
+  - 最新バージョンのv4.0.0には対応していません
+
+# Installation
+
+## ESP-IDFのインストール
+
+公式マニュアルを参照してください。
+
+[ESP-IDF Get Started | v3.3.0](https://docs.espressif.com/projects/esp-idf/en/release-v3.3/get-started/index.html)
+
+## especialのビルド
+
+```sh
+cd ~/esp
+git clone https://github.com/ShotaAk/especial
+cd especial
+
+# 走行プログラムのビルド
+make
+## 書き込み
+make flash
+
+# サンプルプログラムのビルド
+cd examples/0_hello_world 
+make
+## 書き込み
+make flash
+```
+
 # 現在の開発工程
 
 [ここ見て](https://github.com/ShotaAk/especial/milestones)
@@ -12,6 +47,3 @@ ESP32を搭載したマイクロマウスのプログラム
 
 [ここ見て](https://github.com/ShotaAk/especial/issues)
 
-# Installation
-
-そんなのもはない。（TBD)