Write README with project summary and planned features

This commit is contained in:
Camden Dixie O'Brien 2023-05-14 18:20:25 +01:00
parent 3d2790f340
commit cc020d12bf

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Bedside Clock
Networked bedside clock utilising an ESP32-SOLO-1.
## Planned Features
- [ ] Audio alarms
- [ ] 7 segment display
- [ ] WiFi networking
- [ ] Console for configuration
- [ ] TCP API for configuration
- [ ] SNTP synchronisation
## Firmware
The firmware is a standard ESP-IDF v5.0 project; refer to [Espressif's
ESP-IDF
docs](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32/index.html).