root/README @ 9bdc85ae6abb47b8ef60e40acfb7a615a0747a3c

Revision 9bdc85ae6abb47b8ef60e40acfb7a615a0747a3c, 4.0 KB (checked in by dsmith <dsmith@…>, 6 years ago)

Prerelease documentation updates

git-svn-id: http://abstrakraft.org/cwiid/svn/trunk@19 918edb2d-ff29-0410-9de2-eb38e7f22bc7

  • Property mode set to 100644
Line 
1Copyright (C) 2007 L. Donnie Smith <wiimote@abstrakraft.org>
2
3This program is free software; you can redistribute it and/or modify
4it under the terms of the GNU General Public License as published by
5the Free Software Foundation; either version 2 of the License, or
6(at your option) any later version.
7
8This program is distributed in the hope that it will be useful,
9but WITHOUT ANY WARRANTY; without even the implied warranty of
10MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11GNU General Public License for more details.
12
13You should have received a copy of the GNU General Public License
14along with this program; if not, write to the Free Software
15Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
16
17
18------------------------------------------------------------------------------------------------
19CWiid Wiimote Interface
20------------------------------------------------------------------------------------------------
21
22DESCRIPTION
23------------------------------------------------------------------------------------------------
24The CWiid package contains the following parts:
251.wiimote library - API to the wiimote.
262.wmgui - GTK gui to the wiimote.
273.wminput - an event/joystick/mouse driver for the wiimote.
284.wmdemo - a minimal demonstration of the libwiimote API. (not installed)
29
30REQUIREMENTS
31------------------------------------------------------------------------------------------------
32autoconf, awk, bison, flex, bluez-libs, gtk+-2 dev libs, uinput kernel support, kernel sources
33
34INSTALLATION
35------------------------------------------------------------------------------------------------
36./configure
37make
38sudo make install
39
40While CWiid is still in the early development stages, installation directories and filenames are changed more often than in a mature, stable package.  In order to prevent the collection of obselete directories and files, it is recommended that you run 'make uninstall && make uninstall_config' from your current CWiid source directory before installing a new one.  Files are currently installed to the following directories: /usr/local/{bin,etc,lib,lib/cwiid}.  Recently, but no longer, used directories include /usr/share/CWiid - this directory may be deleted.
41
42Many distributions do not have /usr/local/lib in the library search path, and on many of these same distributions, the library installation directory (as determined by autoconf) is /usr/local/lib, creating a problem when you try to run programs depending on libraries installed there. There are two clean ways to fix this:
431.Add a --prefix=/usr argument to ./configure
442.Add /usr/local/lib to /etc/ld.so.conf, then run ldconfig.
45
46I prefer the second method since it keeps local software in the local directory where it should be, and it fixes the problem for every package using /usr/local/lib, not just CWiid.  Until someone offers a convincing argument for the omission of /usr/local/lib from /etc/ld.so.conf, I consider this to be a distribution bug, and method #2 above is the fix.
47
48Please report any compilation errors to <wiimote@abstrakraft.org>.
49
50EXECUTION
51------------------------------------------------------------------------------------------------
52wmgui [-h] [bdaddr]
53wminput [-h] [-c config] [bdaddr]
54
55The bluetooth device address (bdaddr) of the wiimote can be specified on the command-line, or through the WIIMOTE_BDADDR environment variable, in that order of precedence.  If neither is given, the first wiimote found by hci_inquiry will be used.
56See wminput/README for more information on wminput configuration and execution.
57
58FUTURE IDEAS/IMPROVEMENTS
59------------------------------------------------------------------------------------------------
60The following list is neither complete nor ordered:
61lswm (list wiimotes)
62wmcp (copy data between files and wiimotes)
63Move wiimote communications into a separate daemon (wiimoted) with which applications communicate via sockets (or some other means)
64wmgui logging
65Implement speaker
66gui/control interface to wminput
67Implement other drivers such as gesture recognition.
68
Note: See TracBrowser for help on using the browser.