Skip to content

Better README usage documentation #20

@WalkerKnapp

Description

@WalkerKnapp

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions