Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a technical/developer documentation for hacktv #52

Open
Potomac opened this issue Nov 2, 2019 · 0 comments
Open

Create a technical/developer documentation for hacktv #52

Potomac opened this issue Nov 2, 2019 · 0 comments

Comments

@Potomac
Copy link

Potomac commented Nov 2, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant