FreeCAD-addons icon indicating copy to clipboard operation
FreeCAD-addons copied to clipboard

[New Addon/Workbench] CycloidGearBox

Open iplayfast opened this issue 2 months ago • 8 comments

https://github.com/iplayfast/CycloidGearBox/tree/FirstRelease

Dependencies

  • This Addon/workbench runs on:
    • [X] Most up to date stable release (including RC)
    • [X] Most up to date development release
    • [X] Python 3 compatible
    • [X] Qt5 compatible
    • [X] Qt5 and Qt6 compatible (uses "import PySide" rather than "import PySide2")
  • [] Is this backward compatible with any previous version of FC? If so, please mention in the README.md
  • [x] Does this use 3rd party dependencies?
    • [x] numpy
    • [ ] scipy
    • Please specify if there are any other dependencies below and in the README.md and package.xml files

README.md

  • [X] Is Markdown friendly
  • [ ] Has a Prerequisite or Dependencies section
  • [X] Links to a LICENCE file (Note: FreeCAD uses LGPL2.1, most people choose that or GPL3)
  • [X] Has a Screenshot and/or a section for screenshots
  • [ ] Links to a FreeCAD Forum discussion thread

Misc.

Housekeeping

  • [X] Fixed typos in the code using codespell. We recommend running: codespell -q 3
  • [ ] We recommend linting python code with PEP8. See [coding conventions][Code-conventions]

Github Related

  • [X] Does your repository use Release tags ?
  • [X] Repository has topics which include FreeCAD Workbench Addon

Note: if your addon/workbench code doesn't reside on Github, please state the address where it is mentioned

iplayfast avatar Nov 08 '25 17:11 iplayfast

Do you need assistance creating a package.xml file?

chennes avatar Nov 10 '25 15:11 chennes

I guess I do, since I don't know what that is :)

iplayfast avatar Nov 10 '25 22:11 iplayfast

Here's the wiki documentation page -- there are a couple of examples at the bottom you can probably just copy from and tweak to suit your needs. This will ensure that your addon looks nice when displayed in the Addon Manager.

chennes avatar Nov 10 '25 22:11 chennes

OK, done. Let me know if everything looks ok.

iplayfast avatar Nov 13 '25 17:11 iplayfast

@iplayfast Did you not push it?

Image

PhoneDroid avatar Nov 15 '25 17:11 PhoneDroid

I pushed but forgot to release the update. It should be ready now.

iplayfast avatar Nov 17 '25 06:11 iplayfast

Great -- what's your minimum FreeCAD version for this? When we make the catalog entry we will indicate what versions you support.

chennes avatar Nov 17 '25 15:11 chennes

I expect the minimum is pre 1, as that's when I first started developing it. I guess just say 1.

iplayfast avatar Nov 18 '25 18:11 iplayfast