From 6d227bc37a3f339382858bd70b05d1db16f2d3fb Mon Sep 17 00:00:00 2001 From: jakeg00dwin Date: Wed, 4 Dec 2024 19:37:47 -0800 Subject: [PATCH] Added more details on dependencies. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index f43f1b8..ae5ec75 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,21 @@ ## Description +This is a TDD focused template that uses the cpputest testing harness and +CMAKE for the build system. The build system and testing is held together with +the use of the `otto.sh` script. ## Dependencies +- CMAKE >= 3.20 +- CppUTest >= 3.8 +- Bash/Sh shell + + +## Hardware Specific + +Given this template targets the whole range of CH32V20X chips you will want +to define their memory layout to reflect the chip you have chosen. ## Using the template @@ -12,6 +24,12 @@ ### Running Tests +```sh +echo "1" | ./otto.sh +``` + ### Building Binaries + ### Flashing Micro-Controller +