add README

This commit is contained in:
Kinchin Fong 2023-04-16 21:37:48 +08:00
parent a59c69ea3d
commit b530f2627d
1 changed files with 14 additions and 0 deletions

14
README.md Normal file
View File

@ -0,0 +1,14 @@
# DreamTap
A smart switch for developers!
## Usage
1. Install VSCode;
2. Install PlatformIO plugin for VSCode;
3. Copy `include/config_sample.h` to `include/config.h`;
4. Modify `include/config.h` as you wish;
5. Compile this sketch;
6. Connect DreamTap to your computer;
7. Press the side-button and main button at the same time, release main button first, then release side button;
8. Upload this sketch to DreamTap;