Skip to content

Commit

Permalink
Add quick start section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jason-mao committed Nov 12, 2019
1 parent 4a87244 commit 12d8af6
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,19 @@

[AWTK](https://github.com/zlgopen/awtk) is an open source GUI. It's easy to support embedded system, Wechat, WEB, Mobile phone and PC.

# Quick Start

Clone the `esp32-awtk` repository, set up `IDF_PATH`, and then compile, flash and monitor applications in the same way as when working with ESP-IDF.

```
git clone --recursive https://github.com/jason-mao/esp32-awtk.git
cd esp32-awtk/example
export IDF_PATH=$PWD/../esp-idf
make flash monitor
```

# Todo list
- [x] Porting awtk to support ESP32
- [x] Running first demo on ESP-WROVER-KIT
- [x] Running first demo on ESP-WROVER-KIT with WROVER module
- [ ] Support touch input events
- [ ] Implement framebuffer to improve speed

0 comments on commit 12d8af6

Please sign in to comment.