search

FreeSpacenav / libspnav

Library for communicating with spacenavd or 3dxsrv to get input from 6-dof devices.
http://spacenav.sourceforge.net
Other
75 stars 36 forks source link

README.md: added troubleshooting to build examples #22

Closed theHacker closed 4 months ago

theHacker commented 4 months ago

Give directions when hitting compile error:

thehacker@rhea:/tmp/libspnav/examples/fly$ LC_ALL=C make
gcc -pedantic -Wall -O3 -I../.. -I../../src -I/usr/local/include   -c -o fly.o fly.c
fly.c:14:10: fatal error: GL/glu.h: No such file or directory
   14 | #include <GL/glu.h>
      |          ^~~~~~~~~~
compilation terminated.
make: *** [<builtin>: fly.o] Error 1
jtsiomb commented 4 months ago

I don't like the wording at all, and those instructions are for a very specific GNU/Linux distribution (or family of distributions).

If I was going to add something to help with this kind of problem to the readme file, it should be a list of dependencies and optional dependencies, not a list of troubleshooting steps. I'll think about it.

theHacker commented 4 months ago

Understandable.

My thoughts were: I always hate when checking out a piece of software, following the instructions ("easy, just do…"), and then nothing works and I have to dig deep and/or google about the error messages. I was using a Linux Mint, and I fully understand these instructions won't do good for everybody. However, I believe enriching a README file with troubleshooting section is a not bad way. It does not have to help everybody, but the more people/cases it helps, the better. IMHO.

I would welcome a list of dependencies :heart: Would have helped me in my case. Thank you.

jtsiomb commented 4 months ago

I just added a couple of paragraphs about dependencies of libspnav and the example programs in commit 934093823d512ad579c529e7fd5c87e52ff750f5