Documentation to compile from source is out of date for current version of texgen

louisepb / TexGen

TexGen is a geometric textile modelling software package to be used for obtaining engineering properties of woven textiles and textile composites.

GNU General Public License v2.0

53 stars 30 forks source link

Documentation to compile from source is out of date for current version of texgen #57

Closed nes-1 closed 1 year ago

nes-1 commented 1 year ago

https://texgen.sourceforge.io/index.php/Compiling_from_Source

Documentation out of date for current version:

I assume instead of Python 2.7, Python 3 is now required.
Is the SWIG install still version 4.0.0 (although not for the initial build):
What specifically should be installed from OpenCascade because the link is broken: https://dev.opencascade.org/getocc/download
Is version 6.3 of VTK still the version to use
Is ver 3.0.4 of wxWidgets (wxMSW) still used (I see it is possible to get this from their github)
Does the cpp unit test version matter?

louisepb commented 1 year ago

I am in the process of updating this. There is now a file "HowToBuildTexGen.pdf" in the repo with instructions for the Python 3 version.

louisepb commented 1 year ago

I have now updated the documentationfor Python 39. I'm afraid that we're stuck with VTK 6.3.0 until I have time to tackle the significant changes needed to update to a newer version. I've mended the OpenCASCADE link. The current version is built with 7.0.0. The cppunit version is 1.15.1 (I think this is the most recent one) - note that this only works for a release build. Please let me know if I've missed anything.

nes-1 commented 1 year ago

Hi Louise thank you so much! I don't believe anything is missed but I'll go through the process today and check during. Thank you!

nes-1 commented 1 year ago

Thank you so much for updated documentation - it's extra clear! The only (incredibly small) sticky points I noticed were: P.18 When setting up the directory for the python debug, the user will need to manually create the libs folder and scripts folder. Also if the user manually builds just python 3.9 in this manner they should move the python39.dll out of the dll folder to the root with the exe, among other things... P.23 For the wxWidgets install just downloading the correct pre-compiled binaries (developer header) may be okay (vs building from source) although it looks like the dlls may not be in the right location. P.26 It was a little ambiguous that the wxWidgets libraries that should remain not found for the configuration/generation are only the ones indicated in the figure (the cut off files (e.g. tiff, xml) should all be able to be linked manually).

louisepb commented 1 year ago

Thanks for the feedback - much appreciated. I'll try to get around to the updates soon. When it's something you're very familiar with it's easy to miss something that might catch people out.