root/branches/dev/README

Revision 83, 4.2 kB (checked in by dsmith, 2 years ago)

Merge libcwiid rename into trunk

Line 
1 Copyright (C) 2007 L. Donnie Smith <cwiid@abstrakraft.org>
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License as published by
5 the Free Software Foundation; either version 2 of the License, or
6 (at your option) any later version.
7
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 GNU General Public License for more details.
12
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
16
17
18 ------------------------------------------------------------------------------------------------
19 CWiid Wiimote Interface
20 ------------------------------------------------------------------------------------------------
21
22 DESCRIPTION
23 ------------------------------------------------------------------------------------------------
24 The CWiid package contains the following parts:
25 1.libcwiid - wiimote API.
26 2.wmgui - GTK gui to the wiimote.
27 3.wminput - an event/joystick/mouse driver for the wiimote.
28 4.lswm - list wiimote devices (in the spirit of ls{,pci,usb}, etc.
29 4.wmdemo - a minimal demonstration of the libwiimote API. (not installed)
30
31 REQUIREMENTS
32 ------------------------------------------------------------------------------------------------
33 awk, bison, flex, bluez-libs, gtk+-2 dev libs, uinput kernel support, kernel sources
34
35 INSTALLATION
36 ------------------------------------------------------------------------------------------------
37 ./configure
38 make
39 sudo make install
40
41 To install global configuration files to the more familiar /etc rather than /usr/etc or /usr/local/etc, execute configure with --sysconfdir=/etc.
42
43 While 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.
44
45 Many 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:
46 1.Add a --prefix=/usr argument to ./configure
47 2.Add /usr/local/lib to /etc/ld.so.conf, then run ldconfig.
48
49 I 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.
50
51 Please report any compilation errors at http://www.abstrakraft.org/cwiid or to <cwiid@abstrakraft.org>, with preference for the former.
52
53 EXECUTION
54 ------------------------------------------------------------------------------------------------
55 wmgui [-h] [bdaddr]
56 wminput [-h] [-c config] [bdaddr]
57
58 The 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.
59 See wminput/README for more information on wminput configuration and execution.
60
61 FUTURE IDEAS/IMPROVEMENTS
62 ------------------------------------------------------------------------------------------------
63 The following list is neither complete nor ordered:
64 lswm (list wiimotes)
65 wmcp (copy data between files and wiimotes)
66 Move wiimote communications into a separate daemon (wiimoted) with which applications communicate via sockets (or some other means)
67 wmgui logging
68 Implement speaker
69 gui/control interface to wminput
70 Implement other drivers such as gesture recognition.
71
Note: See TracBrowser for help on using the browser.