- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add an ARCHITECTURE.md fle describing the archticture of the F3D project #1887
Comments
Hi @mwestphal, commenting for assignment. Thanks! |
Assigned :) |
Hi @GaganCodes Do you need any help moving forward ? |
Hi @mwestphal, my approach is to go to 'main.cxx' file in /application and keep digging in the functions from there, can you please confirm if that's a good starting point, or if I should be looking at another file to dive into? As an aside, if there's any unit testing to understand the features better, I am all ears. :) |
I'd suggest a different approach. First you want to read the whole documentation on https://f3d.app to learn all about the features. Then You may want to look first at F3DStarter.h Then look at all files in Then look at the vtkext/private vtk module Then look at the plugins If this is too much, let me know, I can take the lead on this if needed :) |
That makes sense @mwestphal , I am new to C++ so appreciate this breakdown of steps. If it's okay, I can do these steps first and then let you know if you need to take the lead or not. :) Edit: Do you have any examples of architecture diagrams / flowcharts? |
Definitely not my forte, I usually use draw.io if I must but I prefer text based stuff in general. |
Is your feature request related to a problem? Please describe.
While the documentation is good for dev, one thing that is missing is a high level architecture documentation explaining how the project is structured.
Describe the solution you'd like
Add a
doc/dev/ARCHITECTURE.md
which should explain what are the different folder for, what do they contain and how they interact with each other in the different processes.The text was updated successfully, but these errors were encountered: