GPUSPH / gpusph

The world's first CUDA implementation of Weakly-Compressible Smoothed Particle Hydrodynamics
160 stars 67 forks source link

Build documentation fails #55

Open saltynexus opened 5 years ago

saltynexus commented 5 years ago

I tried to build the documentation under /gpusph/docs/user-guide using "make" and it fails. Are these documents actually maintained? There is clearly missing figures. If they are not maintained, then remove them from the release to avoid confusion.

I know there are documents on the main homepage, but the ones in the source code appear to be more thorough?

Oblomov commented 5 years ago

We try to keep the documentation updated (albeit with a lower priority than the code itself), but the issue you're having is most definitely due to the missing figures. (We try not to ship binary data with git because the tool isn't really designed to handle it.) I'm keeping this issue open, as a general reminder. The things we need to do are:

saltynexus commented 5 years ago

Any possibility to expedite this? In my opinion "master" should not be made public without proper updated documentation. How do I know if the errors I encounter are bugs/issues or not if I don't know how to run the software as instructed by developers? Just saying.