drm_hwcomposer: Add README.md
Although we had CONTRIBUTING.md, gitlab didn't really highlight it. So I tried putting this info in the wiki, but that was equally hard to discover. _then_ I thought gitlab pages was the right way to go, but no.

Turns out README.md will be harvested by gitlab and shown on the project's frontpage \o/

Signed-off-by: Sean Paul <seanpaul@chromium.org>
1 file changed
tree: 3c6bc5bcb6fd3d2e2972dc9fa613fbbb9ec11a40
  1. tests/
  2. .clang-format
  3. Android.mk
  4. autofd.h
  5. autogl.h
  6. autolock.cpp
  7. autolock.h
  8. drmcompositorworker.cpp
  9. drmconnector.cpp
  10. drmconnector.h
  11. drmcrtc.cpp
  12. drmcrtc.h
  13. drmdisplaycomposition.cpp
  14. drmdisplaycomposition.h
  15. drmdisplaycompositor.cpp
  16. drmdisplaycompositor.h
  17. drmencoder.cpp
  18. drmencoder.h
  19. drmeventlistener.cpp
  20. drmeventlistener.h
  21. drmframebuffer.h
  22. drmhwcgralloc.h
  23. drmhwcomposer.h
  24. drmhwctwo.cpp
  25. drmhwctwo.h
  26. drmmode.cpp
  27. drmmode.h
  28. drmplane.cpp
  29. drmplane.h
  30. drmproperty.cpp
  31. drmproperty.h
  32. drmresources.cpp
  33. drmresources.h
  34. glworker.cpp
  35. glworker.h
  36. hwcomposer.cpp
  37. hwcutils.cpp
  38. MODULE_LICENSE_APACHE2
  39. NOTICE
  40. platform.cpp
  41. platform.h
  42. platformdrmgeneric.cpp
  43. platformdrmgeneric.h
  44. platformhisi.cpp
  45. platformhisi.h
  46. platformminigbm.cpp
  47. platformminigbm.h
  48. README.md
  49. separate_rects.cpp
  50. separate_rects.h
  51. virtualcompositorworker.cpp
  52. virtualcompositorworker.h
  53. vsyncworker.cpp
  54. vsyncworker.h
  55. worker.cpp
  56. worker.h
README.md

drm_hwcomposer

Patches to drm_hwcomposer are very much welcome, we really want this to be the universal HW composer implementation for Android and similar platforms So please bring on porting patches, bugfixes, improvements for documentation and new features.

A short list of contribution guidelines:

  • Submit changes via gitlab merge requests on gitlab.freedesktop.org

  • drm_hwcomposer is Apache 2.0 Licensed and we require contributions to follow the developer's certificate of origin: http://developercertificate.org/

  • When submitting new code please follow the naming conventions documented in the generated documentation. Also please make full use of all the helpers and convenience macros provided by drm_hwcomposer. The below command can help you with formatting of your patches:

    `git diff | clang-format-diff-3.5 -p 1 -style=file`
    
  • Hardware specific changes should be tested on relevant platforms before committing.

If you need inspiration, please checkout our TODO issues

Happy hacking!