Skip to content

Commit

Permalink
add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BrendanBall committed Dec 30, 2023
1 parent 569510c commit 836328f
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
# Airquamon
Monitor air quality, starting with C02.
This project currently uses the ESP32-C3 MCU and is implemented in Rust (no_std).
It periodically reads the sensor data (CO2, temperature, humidity) and displays it on an e-ink display.
See [Display Themes](display_themes/README.md) for more info on the display themes.

Table of Contents:
- [Display Themes](display_themes/README.md)
## Building and Flashing
To build:

```sh
cd esp32c3_nostd
cargo build --release
```

To flash:
```sh
cd esp32c3_nostd
cargo run --release
```

## Hardware
- [Sensirion SCD41](https://sensirion.com/products/catalog/SCD41)
Expand Down

0 comments on commit 836328f

Please sign in to comment.