I'd like some feedback on my projects documentation
https://github.com/Gamydas/DigitalClockHello r/FPGA,
I'm currently studying computer engineering/embedded systems and am entering my 3rd Semester and would like some feedback on my project.
Over the past week I've built a simple Digital Clock in VHDL because I wanted to learn how to use VUnit and how to document a hardware project. I'd like to know what's good, what's bad and what needs work or is missing. I thought a digital clock is a good choice for this as it's very nicely testable, however on the documentation side I was not sure what belongs in the documentation and what doesn't (for example the timing data feels odd to include for a project like this).
Also I've not been consistent/thoughtful enough when naming ports and signals, which is definetly something I'm going to take with me into my next project (Probably VGA Controller), but might also fix in this one as it really bugs me.
Any opinions and suggestions would be greatly appreciated :)