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

Better README usage documentation #20

Open
WalkerKnapp opened this issue Sep 3, 2021 · 1 comment
Open

Better README usage documentation #20

WalkerKnapp opened this issue Sep 3, 2021 · 1 comment

Comments

@WalkerKnapp
Copy link
Owner

WalkerKnapp commented Sep 3, 2021

The current README Usage section is very lacking. It currently says:

Devolay aims to be close to the original NDI SDK while still following Java standards and conventions. The vast majority of applications can be simply translated from NDI SDK calls to Devolay calls.

Examples can be found in examples/src/main/java/me/walkerknapp/devolayexamples.

This is lacking because we don't explain the exact differences between using the NDI SDK in C++ and using Devolay.

If possible, I would like to turn this into a section that can:

  • Introduce Devolay to users who are new to both this project and the NDI SDK in C++
  • Give detailed explanations for how to translate code from C++ to Java.
@WalkerKnapp
Copy link
Owner Author

Additionally, it would be great if we could provide more detailed instructions or examples for integration into android projects. It's a complicated subject, and I can see many situations where there would be demand for better instructions.

(i.e., for @chenguo123456, feel free to talk about instructions for Android platforms here. I don't do support via email, but you can ask anything to be included in the documentation here)

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