artoolkitx / artoolkit5

ARToolKit v5.x
Other
108 stars 28 forks source link

documentation: missing bits about artoolkit5-setenv #176

Open umlaeute opened 3 years ago

umlaeute commented 3 years ago

the documentation (current README) says, to run this command:

cd ~/SDKs/ARToolKit5/
./share/artoolkit5-setenv

i think this information is incomplete: after running the script you cannot use ARToolKit right away:

$ echo ${ARTOOLKIT_ROOT}

$ mkdir -p /tmp/ARToolKit5/
$ tar -f ARToolKit5-bin-5.4.0-Linux-x86_64.tar -x -C /tmp/ARToolKit5/
$ cd /tmp/ARToolKit5/
$ ./share/artoolkit5-setenv
*** Successfully set ARTOOLKIT5_ROOT to /tmp/ARToolKit5 ***
$ echo ${ARTOOLKIT_ROOT}

$

instead you must open a new shell in order to "see" the newly set envvars.

you also might want to clarify in the documentation that running this script is a permanent change. (I often unpack SDKs into /tmp while evaluating them; this folder will be cleared on reboot; however, after a reboot the ARTOOLKIT_ROOT envvar will still be set to the old (and now: bogus) value)