diff --git a/README.md b/README.md index d1a9c05..017861e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # azkoyen_technical_test -Azkoyen technical test implementation. Implemented (mostly) on standard c++ 17 framework, but with Qt wherever was necessary \ No newline at end of file +Azkoyen technical test implementation. Implemented (mostly) on standard c++ 17 framework, but with Qt wherever was necessary. + +## Development approach + +A Test-Driven Development (TDD) workflow was followed throughout the project. Every component — from the lowest-level file reader to the GUI window — has a corresponding Google Test suite that was written before (or alongside) the production code. This ensures each module behaves correctly in isolation and makes regressions immediately visible. + +## SysfsRead class + +- Will convert the contents of a file and output an enum class +- Reads a sysfs-like file +- If the file is missing, the reader will output Unreachable +- If the file contains only a "1" the reader will output Enabled +- If the file contains "error: temp too high", the reader will output ErrorTempTooHigh +- if the file contains any other value the reader will output UnexpectedValue +- if the file is empty: it will output Empty +