ommpfritt icon indicating copy to clipboard operation
ommpfritt copied to clipboard

Documentation

Open reahari opened this issue 2 years ago • 4 comments

The readme says that omm was designed to be very easy to use [...] without studying the manual, however, even after watching the (outdated) screen cast I still find the software difficult to use. Also I couldn't actually find any manual.

The main problems I found with the video is that it is silent with no captions or written explanations of what is happening at any point.

What is sorely needed are:

  • Detailed documentation of the user interface, including what each section of the interface is (e.g. https://inkscape-manuals.readthedocs.io/en/latest/interface.html )
  • A walkthrough of creating a basic project/animation (written and/or annotated video)
  • Glossary of terms specific to this software (see Processing's reference for inspiration https://processing.org/reference )

The software looks like it has great potential and I would happyily contribute to documentation but I can't due to the very limited existing docuemtnation

reahari avatar Feb 10 '23 16:02 reahari