Conversation
Updated links and removed outdated sections from the README.
There was a problem hiding this comment.
Pull request overview
Updates the project README to refresh external references and remove outdated informational sections, keeping the documentation aligned with current FreeCAD addon ecosystem pointers.
Changes:
- Added guidance about available branches for this addon.
- Updated addon source and submission documentation links to point at
FreeCAD/Addons. - Removed the “Addon Manager Design Goals” and “Roadmap” sections from the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Note that there are multiple available branches of this addon. Most users should use Main, but Development is also | ||
| available and may contain work-in-progress features (but may also be less stable). For users on older versions of | ||
| FreeCAD built using Qt5 and/or Python 3.8, a dedicated branch is available. |
There was a problem hiding this comment.
The new branch guidance isn’t actionable because it says “a dedicated branch is available” for Qt5/Python 3.8 users but doesn’t specify the branch name (or the branch display name users will see) or link to it. Please name the branch(es) explicitly (e.g., the exact git_ref / branch display name) so users know what to select.
| FreeCAD built using Qt5 and/or Python 3.8, a dedicated branch is available. | |
| FreeCAD built using Qt5 and/or Python 3.8, the `qt5-py38` compatibility branch is available: see [`qt5-py38` on GitHub](https://github.com/FreeCAD/AddonManager/tree/qt5-py38). |
| Addon Manager is no longer the most recent version. Install *this* addon to update the internal Addon Manager to the | ||
| latest version (and to allow future self-updating). | ||
|
|
||
| Note that there are multiple available branches of this addon. Most users should use Main, but Development is also |
There was a problem hiding this comment.
Consider formatting branch names as inline code (e.g., Main, Development) to make it unambiguous that these are literal branch choices rather than general adjectives.
| Note that there are multiple available branches of this addon. Most users should use Main, but Development is also | |
| Note that there are multiple available branches of this addon. Most users should use `Main`, but `Development` is also |
| ## Information for Addon Developers | ||
|
|
||
| To submit an addon you have created see the documentation [here](https://github.com/FreeCAD/FreeCAD-addons/blob/master/Documentation/Submission.md). | ||
| To submit an addon you have created see the documentation [here](https://github.com/FreeCAD/Addons/blob/main/Documentation/Submission.md). |
There was a problem hiding this comment.
Minor grammar: “To submit an addon you have created see …” reads like it’s missing punctuation. Consider “To submit an addon you have created, see …” (or rephrase) for clarity.
| To submit an addon you have created see the documentation [here](https://github.com/FreeCAD/Addons/blob/main/Documentation/Submission.md). | |
| To submit an addon you have created, see the documentation [here](https://github.com/FreeCAD/Addons/blob/main/Documentation/Submission.md). |
1 participant
Updated links and removed outdated sections from the README.