Documentation

[reahari]

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

[pasbi]

Hi reahari.

Thanks for your comment.
Indeed, the documentation is outdated.
Currently I don't have much time to work on the project because of private issues.
But I plan to spend more time on it, maybe in a few months.

Currently I'm overhauling some stuff under the hood, which turned out to be much more complex and difficult than I expected (#240).

Anyway, that won't change the user interface very much.
So I'd appreciate MRs with better documentation very much.

Don't hesitate to contact me if you need help with installation, usage or whatever.

[pasbi]

Seems like the telegram link is broken. This one should work.

https://t.me/+RhYkmsPYsL7zadYE
The gitter chat works, too.
https://gitter.im/ommpfritt/community

[reahari]

So I'd appreciate MRs with better documentation very much.

The problem is I can't create a MR with documentation because I can't use the software! I tried for a few hours but found it really difficult and disheartening and gave up. It's a bit of a chicken and egg situation tbh.

Once I can get something out of the software I will gladly write a tutorial but until then I will wait until you as developer create a basic tutorial

[pasbi]

Sure, I understand that.
I'd like to help you, but I need a bit more information, like:

• do you face issues using or installing omm?
• have you downloaded the binaries (package, installer, etc.) or do you try to compile it yourself?
• what OS are you using?
• what's the actual problem? Is there an error message, does it crash, etc.

Currently I focus on developing, not packaging.
As you can see, the latest release is quite old.
I also don't test the installers regularly, though, I guess the easiest way to install omm on Windows is using the (outdated) installer, or the AppImage for Linux.