WordClock is a hobby project, aiming to create a nice looking time keeping art work.
The secondary goal is to have a project to experiment with various technologies like Rust, laser cutting, 3d printing, and various engineering skills like software architecture, software requirements, Test-Driven Development and technical documentation.
The User guide is part of the GitHub page documentation.
A GitHub project is used for tasks management. The project follow the Semantic versioning scheme.
. ~/export-esp.sh
cargo xbuild
espflash /dev/tty.usbserial-0001 crates/cross_compiled/target/xtensa-esp32-espidf/debug/cross_compiled --flash-freq 80M --flash-size 4MB --flash-mode DIO --speed 921600 --partition-table crates/cross_compiled/esp32_ota_partitions.csv
Add --monitor option to espflash to open the serial consol of the device directly after flashing.
Follow the instruction from https://github.com/esp-rs/esp-idf-template to create similar project from template.
mdbook is used for rendering the documentation in the doc/ folder.
It can be generated with:
mdbook build
To build and open locally the documentation, use:
mdbook serve --open
A GitHub page host the generated documentation, built automatically by GitHub action on every pull-request.
.
|-- 3d printed // 3d printed part of clock
|-- book.toml // mdbook configuration for rendering the documentation
|-- Cargo.toml // Rust workspace configuration
|-- crates // Rust source code
|-- doc // Project documentation
|-- LICENSE.txt
|-- ota-image // Firmware Over The Air update image
|-- README.md // This file
|-- target // Build output for Rust binary and documentation
Licensed under MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)