I notice that there is no technical/developer documentation for hackTV, the only documentation is a short readme file.
This can be a problem when a developer wants to understand how the software works, or join the team, or fork or re-use some of the hacktv algorithms in his own software.
A more general documentation (wiki, pdf file) is also a solution, in order to explain the algorithms, the pal/secam/ntsc color theory, the fm/am modulation, how hackTV uses external library (gnu-radio, ffmpeg) etc...
Another way to increase the value and the maintainability of hackTV : put its features (SDR, pal/secam/ntsc signal generation) in a library, an API, that can be called by other softwares.
Hello,
I notice that there is no technical/developer documentation for hackTV, the only documentation is a short readme file.
This can be a problem when a developer wants to understand how the software works, or join the team, or fork or re-use some of the hacktv algorithms in his own software.
Doxygen is a tool for building documentation and could be a solution : https://en.wikipedia.org/wiki/Doxygen
A more general documentation (wiki, pdf file) is also a solution, in order to explain the algorithms, the pal/secam/ntsc color theory, the fm/am modulation, how hackTV uses external library (gnu-radio, ffmpeg) etc...
Another way to increase the value and the maintainability of hackTV : put its features (SDR, pal/secam/ntsc signal generation) in a library, an API, that can be called by other softwares.