mainly this: https://bcfier.com/ it is a parser and there is a GUI based on the parser. Since it is C# it is of no real use for FreeCAD, but we might get some ideas from it.
Thank you for linking the original topic and bcfier! It will spare me a great deal of work probably, since I am a guy who always starts at the bottom and develops all by himself and later discovering that it basically was unnecessarybernd wrote: ↑Sat Apr 06, 2019 6:06 pmPatrick, you may read this ... https://forum.freecadweb.org/viewtopic.php?p=175525
Yes, certainly! I had it planned like this, but I think it should be pointed out more in the proposal.bernd wrote: ↑Sat Apr 06, 2019 2:49 pmgreat proposal. BCF support would for FreeCAD would be very cool. Just a remark from my side. I would split it into a nongui bcf parser which just parses bcf and could be the base for all kind of development in the regard of bcf. A gui inside FreeCAD would just be one of these smart developments.
The documentation part will get expanded. Allow me this one question: How is the documentation style currently in FreeCAD? Till now I only looked a bit into the FEM workbench, which does not give the whole picture. I reckon that much of the code is documented in doxygen style (or something similar) that can be parsed in a nice format (like html or pdf in case of doxygen). And then there are tutorials, which I know of, because used one of them to get a hold of the FEM workbench ^^yorik wrote: ↑Sat Apr 06, 2019 7:15 pmVery good plan. I would just write a bit more about the documentation part, which is very important in opens-source projects.
I fully agree with bernd about splitting between GUI and non-GUI components too, and I'll certainly have something to say about the GUI later on but at this point, I think your proposal is fine and there is no need to have every technical aspect already solved.
One important thing too, I'd suggest you create yourself a github account (or any other git hosting platform like gitlab, but github makes pull requests very easy) and fork the FreeCAD project, and inform your github account in your proposal, so google people can see you have everything ready.
I am not sure you'd actually need to work directly on the FreeCAD source code (your project can very well be a fully independent plugin), but it doesn't harm to get used to git as soon as possible, if you haven't worked with it yet.
Aren't we all like that
The main doc is the wiki at https://www.freecadweb.org/wiki . Then we have the doxygen-generated docs too, but are in a pretty bad state now.... But have a look at this plugin that I developed last month: https://github.com/opensourceBIM/BIMbots-FreeCAD
I updated my proposal today by adding a section which details my plans on how to document my work. It is almost the same as you suggested and pursued in the BIMbots-FreeCAD pluginyorik wrote: ↑Sun Apr 07, 2019 3:36 pm....
Basically I think your BCF plugin could be developed more or less under the same mold: Self-contained git repo, and the doc is made in two parts: one is automatic, extracted from the python code with pdoc (could be doxygen too, doesn't really matter) and the other is a user-oriented GUI documentation which I did by hand. You can also host the doc on the FreeCAD wiki (that's what Amritpal did in his 2017 GSOC project), as you prefer. At the moment that's not a very important issue.