diff --git a/README.md b/README.md index 804c77f006c3464a0ec470139ca0d653f71da00b..8dfe60feacfdcc700db8e290e452942a6894628d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # DIOT Monitoring Module (MoniMod) -This is a SAMD21-based monitoring module for the DI/OT power supply -and fan tray. +The DIOT Monitoring Module (MoniMod) is a SAMD21-based PMBus +monitoring module for +the [DI/OT project's](https://www.ohwr.org/project/diot/wikis/home) +power supply and fan tray. It can monitor the voltage and current for +up to three power rails. It can also host up to three temperature +sensors, and control up to three fans without requiring them to +support PWM. -*Disclaimer: this README is still incomplete, it will be properly -populated in time.* +Detailed documentation can be found at the +project's [readthedocs page](https://diot-monimod.readthedocs.io). ## Repository structure diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 99625647b10423ac99f6a45c83d87079727f173c..05419ce837ca4f09beb11f0fe08de1cbb7d0da19 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -1,8 +1,11 @@ Overview ======== -The DIOT Monitoring Module (MoniMod) is a SAMD21-based monitoring -module for the DI/OT project's [#DIOT]_ power supply and fan tray. +The DIOT Monitoring Module (MoniMod) is a SAMD21-based PMBus +monitoring module for the DI/OT project's [#DIOT]_ power supply and +fan tray. It can monitor the voltage and current for up to three power +rails. It can also host up to three temperature sensors, and control +up to three fans without requiring them to support PWM. Repository Structure