added FAQ and git-lfs notice

pull/26/head
John Tsiombikas 2022-05-04 16:44:58 +03:00
rodzic 4630ed1d87
commit 114589a320
1 zmienionych plików z 23 dodań i 0 usunięć

Wyświetl plik

@ -39,6 +39,11 @@ installing system-wide.
For build options, see `./configure --help`.
> Note: if you cloned the source code from the git repo without GIT-LFS, the
> image in `icons/devices.png` will be invalid leading to an incorrect build and
> crashes on startup. If you don't want to install GIT-LFS, you can grab the
> file from the latest release archive and drop it in place.
License
-------
Copyright (C) 2007-2022 John Tsiombikas <nuclear@member.fsf.org>
@ -47,3 +52,21 @@ This program is free software. Feel free to use, modify, and/or redistribute
it under the terms of the GNU General Public License version 3, or (at your
option) any later version published by the Free Software Foundation.
See COPYING for details.
FAQ
---
1. **Q**: I'm trying to build spnavcfg, but the linker complains about missing
functions starting with `spnav_cfg_`.
**A**: You need libspnav v1.0 or higher to build spnavcfg. If it is installed,
but you also have a previous version installed in a different path, please
remove it in case the linker finds that one first.
2. **Q**: When I ran spnavcfg, it immediately crashes with a SIGFPE.
**A**: This is most likely caused by bulding with an invalid device atlas
image. If you cloned the source code from git, you need GIT-LFS to
correctly retreive the image from the repo. Without GIT-LFS, the file
`icons/devices.png` will be a text file with a hash instead of a PNG file.
If you don't want to install GIT-LFS, grab the file from the latest release
archive and drop it in.