AnimationFreeCAD icon indicating copy to clipboard operation
AnimationFreeCAD copied to clipboard

Unable to download the help documentation for the Animation WB

Open raindropsfromsky opened this issue 11 months ago • 2 comments

I am using the Animation WB for the very first time, and I am trying to read the help docs.

I reached this help page, but there is no text there.

I had to search hard to locate the user guide pdf file, as it is hidden inside other code.

Desired:

  1. Please make it easy for non-coders to reach the help file. There should be a direct download link at the top.
  2. As a non-coder, I have no clue how to make use of the init and py files. There should be enough guidance for this.

raindropsfromsky avatar Mar 06 '25 02:03 raindropsfromsky

Here is the link to download the English user guide : doc.

I hope it will be helpful. However, we wrote this document at the request of the university 3 years ago, and we only translated it from French, so there may be some translation errors.

But I don't understand why you would like to know "how to make use of the init and py files.". Do you mean there should be documentation about the code written so other people could participate in the project ?

But I don't understand why you would like to know "how to make use of the init and py files.". Are you suggesting that there should be documentation about the code so that others can participate in the project?

QuentinTournier40 avatar Mar 06 '25 08:03 QuentinTournier40

Here is the link to download the English user guide : doc.

Thanks, but the users won't be looking at GitHub issues to discover this link. Therefore, it is best to provide this direct link in the Addon Manager's page for the Animation WB. Image

I don't understand why you would like to know "how to make use of the init and py files.". Do you mean there should be documentation about the code written so other people could participate in the project ?

I am not sure what these files do; especially because this code is listed in the "documentation" page. (Usually, the code is not posted as documents.)

In many apps, a script is provided that the user has to copy and paste as a local file, and then edit it. Finally he has to place this modified file in a certain installation folder, so that the app makes use of it.

It looked similar to that type of application. (As mentioned, I am not a coder, so I cannot guess the purpose of such files.)

raindropsfromsky avatar Mar 06 '25 10:03 raindropsfromsky