Add READMEs to all components

[JRegimbal]

This is mainly to aid in documentation. Most components (aside from some preprocessors which already have them) do not include a README file. A per-component README file would be an excellent place to document how each component works and what it is meant to do, along with any quirks that would be important to know. This README can also be referenced in our docker images (where applicable) using the OCI org.opencontainers.image.documentation key, which may be used by GitHub itself in generating the page for each package (currently it uses the project-wide README).

[Cybernide]

Let me know if I can help with this. Would welcome the chance to brush the dust off of those tech writing skills.

[JRegimbal]

Alright, here's the state as of today. Components in italics are deprecated and lower priority, but still good to include something for.

• [x] Orchestrator
• [x] Services
  • [x] SuperCollider
  • [x] ESPnet TTS
• [ ] Handlers
  • [x] Autour
  • [x] Generic TTS
  • [x] Hello Handler
  • [x] Hello Haptics (@sriGanna @rayanisran)
  • [x] Hello TTS
  • [x] Highcharts
  • [x] MOTD
  • [x] Object Text
  • [x] OCR (@BenMacnaughton @aidanwilliams09)
  • [x] Photo Audio
  • [x] Photo Audio Haptics (@sriGanna @rayanisran)
  • [x] Pie Chart
  • [x] Segment
• [x] Preprocessors
  • [x] Autour
  • [x] Chart Pipeline
  • [x] Content Categoriser
  • [x] Graphic Tagger (~@gp1702~ @rohanakut)
  • [x] Grouping
  • [x] Hello, Preprocessor (@JRegimbal)
  • [x] Object Detection (Azure) (~@gp1702~ @rohanakut)
  • [x] OCR (@BenMacnaughton @aidanwilliams09)
  • [x] CSAIL Semantic Segmentation
  • [x] Sorting (@rohanakut)
  • [x] Object Detection (YOLO)
• [x] Miscellaneous (@JRegimbal)
  • [x] SuperCollider Base Image
  • [x] SuperCollider "Extra" Image

Thanks to everyone for their work so far!

[jeffbl]

Note that even if something is deprecated, that needs to be stated, and ideally point to what replaced it, or what value it might have for posterity. For example, see the README at: https://github.com/Shared-Reality-Lab/IMAGE-server/tree/main/handlers/pie-chart-handler

[JRegimbal]

Note for me, after this is done the following containers will still need OCI labels: OCR preprocessor & handler, Azure obj. det. and graphic tagger, and haptics handlers.

[jeffbl]

@JRegimbal It looks like there is at least something for even the unchecked items above. Anything you're aware of that still needs revision/additions?

[JRegimbal]

OCR handler is missing one still. I think some could benefit from a bit more detail but I think the bar has been met for the ones that are currently present.

[jeffbl]

@BenMacnaughton @aidanwilliams09 Please create README for OCR Handler, modeled on the ones for other handlers, then assign this to Juliette for final review. Thanks!

[jeffbl]

I just created a very basic OCR handler README as the last one pending, so I am closing this as complete. @BenMacnaughton @aidanwilliams09 please edit directly if there are any other useful comments/clarifications.