Update the readme file

This commit is contained in:
Ryan Pavlik
2010-11-11 13:19:49 -06:00
parent 394ade9cf0
commit fa5763db04

38
README
View File

@@ -4,6 +4,9 @@
- -
--------------------------- ---------------------------
Fork, located at: http://github.com/rpavlik/wiiuse
Original project:
http://wiiuse.net/ http://wiiuse.net/
http://wiiuse.sourceforge.net/ http://wiiuse.sourceforge.net/
http://sourceforge.net/projects/wiiuse/ http://sourceforge.net/projects/wiiuse/
@@ -18,9 +21,16 @@ ABOUT
Distributed under the GPL and LGPL. Distributed under the GPL and LGPL.
This is a friendly fork, prompted by apparent non-maintained status of
upstream project but proliferation of ad-hoc forks without project
infrastructure. Hopefully GitHub will help the community maintain this
more seamlessly now.
AUTHORS AUTHORS
Fork Maintainer: Ryan Pavlik <rpavlik@iastate.edu> or <abiryan@ryand.net>
Michael Laforest < para > Michael Laforest < para >
Email: < thepara (--AT--) g m a i l [--DOT--] com > Email: < thepara (--AT--) g m a i l [--DOT--] com >
@@ -93,13 +103,21 @@ PLATFORMS AND DEPENDENCIES
- Bluetooth driver (tested with Microsoft's stack with Windows XP SP2) - Bluetooth driver (tested with Microsoft's stack with Windows XP SP2)
- If compiling, Microsoft Windows Driver Development Kit (DDK) - If compiling, Microsoft Windows Driver Development Kit (DDK)
For either platform:
- If compiling, CMake is needed to generate a makefile
COMPILING COMPILING
Linux: Linux:
You need SDL and OpenGL installed to compile the SDL example. You need SDL and OpenGL installed to compile the SDL example.
# make [target] $ cd build
$ ccmake .. [-DCMAKE_INSTALL_PREFIX=/usr/local] [-DCMAKE_BUILD_TYPE=Release]
OR
$ cmake-gui ..
$ make [target]
If 'target' is omitted then everything is compiled. If 'target' is omitted then everything is compiled.
@@ -108,36 +126,28 @@ COMPILING
- wiiuse - wiiuse
Compiles libwiiuse.so Compiles libwiiuse.so
- ex - wiiuseexample
Compiles wiiuse-example Compiles wiiuse-example
- sdl-ex - wiiuseexample-sdl
Compiles wiiuse-sdl Compiles wiiuse-sdl
Become root. Become root.
# make install # make install
The above command will only install the binaries that you
selected to compile.
wiiuse.so is installed to /usr/lib wiiuse.so is installed to /usr/lib
wiiuse-example and wiiuse-sdl are installed to /usr/bin wiiuse-example and wiiuse-sdl are installed to /usr/bin
Windows: Windows:
A Microsoft Visual C++ 6.0 project file has been included. The CMake GUI can be used to generate a Visual Studio solution.
You need the install the Windows DDK (driver development kit) You need the install the Windows DDK (driver development kit)
to compile wiiuse. Make sure you include the inc/ and lib/ to compile wiiuse.
directories from the DDK in your IDE include and library paths.
You can download this from here: You can download this from here:
http://www.microsoft.com/whdc/devtools/ddk/default.mspx http://www.microsoft.com/whdc/devtools/ddk/default.mspx
You need to link the following libraries (already set in the You might also need to install the latest Windows SDK.
included project file):
- Ws2_32.lib
- hid.lib
- setupapi.lib
USING THE LIBRARY IN A THIRD PARTY APPLICATION USING THE LIBRARY IN A THIRD PARTY APPLICATION