[giimote commit] r197 - Updated the wiki with instructions for obtaining and building GiiMote from source
codesite...@google.com
Date: Fri May 8 22:37:10 2009
New Revision: 197
Added:
wiki/BuildDocumentation.wiki
wiki/Gzip.wiki
wiki/Subversion.wiki
wiki/Tar.wiki
wiki/TlbExp.wiki
Modified:
wiki/WiimoteLib.wiki
Log:
Updated the wiki with instructions for obtaining and building GiiMote from
source
Added: wiki/BuildDocumentation.wiki
==============================================================================
--- (empty file)
+++ wiki/BuildDocumentation.wiki Fri May 8 22:37:10 2009
@@ -0,0 +1,58 @@
+#summary Instructions for obtaining and compiling GiiMote
+#labels Type-Article,Phase-Implementation,Featured
+
+= Introduction =
+
+Unfortunately, building GiiMote from source is not as simple as
downloading the source and running a few scripts. The build process relies
on many different tools, many of which must be downloaded, installed, and
configured separately from GiiMote. The recommended (and only supported)
environment for building GiiMote is
[http://msdn.microsoft.com/en-us/vstudio/default.aspx Visual Studio] or
[http://www.microsoft.com/express/vc/ Visual C++ Express].
+
+= Getting the source =
+There are several different ways to get the source.
+
+== Tarball ==
+
+A source tarball is available over HTTP and can be found by searching the
[http://code.google.com/p/giimote/downloads/list?can=1&q=.tar.gz downloads
page].
+
+== Subversion ==
+
+You can also checkout a working copy of GiiMote from the
[http://giimote.googlecode.com/svn/ SVN repository]. To get a working copy
from subversion please follow the instructions on
[http://code.google.com/p/giimote/source/checkout this page].
+
+If you obtain the source from SVN it will not always build properly. To
get a copy of a stable release look in the
[http://giimote.googlecode.com/svn/tags/ tags directory].
+
+== Browse source on the Web ==
+
+If you merely want to look over the source code or download individual
files you can browse the source code on the web by visiting
[http://code.google.com/p/giimote/source/browse/ this page]. You can also
access the SVN repository over http [http://giimote.googlecode.com/svn/
here].
+
+
+= Build prerequisites =
+
+Before you attempt to build GiiMote make sure you have the proper tools
and that they are configured correctly and visible to your build
environment.
+
+== Release ==
+These dependencies are only used when you build GiiMote with the
[ReleaseConfiguration release configuration]. This configuration does not
embed debugging symbols and exports a source tarball and typelibrary after
the build.
+
+ * [Subversion]
+ * [Tar]
+ * [Gzip]
+
+== Debug ==
+The [DebugConfiguration debug configuration] does not have any
configuration-specific dependencies.
+
+== MATLAB ==
+To build GiiMote for [MATLAB] you must have a licensed copy of MATLAB. To
find out more visit [http://www.mathworks.com/ The MathWorks].
+
+== All Configurations ==
+
+ * [NetFramework .NET Framework]
+ * [WiimoteLib]
+ * [TlbExp]
+
+
+= Build =
+
+After you have all of your tools configured and the source downloaded you
can finally build GiiMote. A solution for Visual Studio or Visual C++
Express is provided with the source. This is the recommended and only
supported method for building GiiMote. Building in Visual Studio or Visual
C++ Express is as easy as opening
[http://code.google.com/p/giimote/source/browse/trunk/GiiMote.sln
GiiMote.sln] in the IDE, selecting a configuration ("[ReleaseConfiguration
Release]", "[DebugConfiguration Debug]", or "[MatlabConfiguration
MATLAB]"), and pressing build.
+
+= Links =
+
+ * [http://code.google.com/p/giimote/source/browse/ code browser]
+ * [http://giimote.googlecode.com/svn/ SVN repo]
+ * [http://giimote.googlecode.com/svn/tags/ Stable releases]
\ No newline at end of file
Added: wiki/Gzip.wiki
==============================================================================
--- (empty file)
+++ wiki/Gzip.wiki Fri May 8 22:37:10 2009
@@ -0,0 +1,12 @@
+#summary Description of Gzip.exe and is place in the build process
+#labels Phase-Requirements
+
+= Introduction =
+
+Gzip.exe is used in the [ReleaseConfiguration "Release" configuration] by
[Tar Tar.exe] to compress the source tarball which is generated after
compiling GiiMote. To use gzip you must:
+ * Download GNU's gzip tool [http://www.gnu.org/software/gzip/ here]
+ * Place gzip.exe in a location where it is visible from the command line
+
+= Links =
+
+ * [http://www.gnu.org/software/gzip/ GNU's Gzip tool]
Added: wiki/Subversion.wiki
==============================================================================
--- (empty file)
+++ wiki/Subversion.wiki Fri May 8 22:37:10 2009
@@ -0,0 +1,14 @@
+#summary Description of Subversion and is place in the build process
+#labels Phase-Requirements
+
+= Introduction =
+
+Subversion is used in the [ReleaseConfiguration "Release" configuration]
to export a clean (non-revisioned) copy of the source from which a tarball
can be created.
+To install and configure subversion you will need to:
+ * Download and compile subversion or find and download subversion
binaries from the [http://subversion.tigris.org/ subversion website].
+ * Place the subversion binaries in a folder on your computer where they
are visible to the command line
+
+
+= Links =
+
+ * [http://subversion.tigris.org/ Subversion website]
Added: wiki/Tar.wiki
==============================================================================
--- (empty file)
+++ wiki/Tar.wiki Fri May 8 22:37:10 2009
@@ -0,0 +1,16 @@
+#summary Description of Tar.exe and is place in the build process
+#labels Phase-Requirements
+
+= Introduction =
+
+Tar.exe is used in the [ReleaseConfiguration "Release" configuration] to
create a source tarball after compiling GiiMote. To use tar you must:
+ * Download GNU's tar tool [http://www.gnu.org/software/tar/ here]
+ * Place Tar.exe in a location where it is visible to the command line
+
+= Dependencies =
+
+ * [Gzip]
+
+= Links =
+
+ * [http://www.gnu.org/software/tar/ GNU's implementation of Tar]
Added: wiki/TlbExp.wiki
==============================================================================
--- (empty file)
+++ wiki/TlbExp.wiki Fri May 8 22:37:10 2009
@@ -0,0 +1,11 @@
+#summary Description of TlbExp and is place in the build process
+#labels Phase-Requirements
+
+= Introduction =
+
+TlbExp is a tool which is included with the .NET Framework. It is used to
export a [TypeLibrary type library] after the build process has been
completed.
+
+
+= Links =
+
+ * [http://msdn.microsoft.com/en-us/library/hfzzah2c.aspx TlbExp
documentation at MSDN]
Modified: wiki/WiimoteLib.wiki
==============================================================================
--- wiki/WiimoteLib.wiki (original)
+++ wiki/WiimoteLib.wiki Fri May 8 22:37:10 2009
@@ -1,11 +1,23 @@
-#summary A managed library for using the Wii Remote from .NET
-#labels Phase-Design
-
-= Introduction =
-
-WiimoteLib is a managed library written in C# to use the Wii Remote as a
bluetooth HID device from .NET. WiimoteLib is the base library for GiiMote.
-
-
-= Details =
-
-WiimoteLib was started by [http://brianpeek.com/ Brian Peek] as an article
for Microsoft's [http://blogs.msdn.com/coding4fun/ Coding4Fun] website. The
original article contains basics on the design and internals of the library
and can be found
[http://blogs.msdn.com/coding4fun/archive/2007/03/14/1879033.aspx here].
WiimoteLib is open source and licensed under the MS-Pl. The source code can
be found at the [http://www.codeplex.com/WiimoteLib WiimoteLib CodePlex
site].
\ No newline at end of file
+#summary A managed library for using the Wii Remote from .NET
+#labels Phase-Design, Phase-Implementation
+
+= Introduction =
+
+WiimoteLib is a managed library written in C# to use the Wii Remote as a
bluetooth HID device from .NET. WiimoteLib is the base library for GiiMote.
+
+
+= Details =
+
+WiimoteLib was started by [http://brianpeek.com/ Brian Peek] as an article
for Microsoft's [http://blogs.msdn.com/coding4fun/ Coding4Fun] website. The
original article contains basics on the design and internals of the library
and can be found
[http://blogs.msdn.com/coding4fun/archive/2007/03/14/1879033.aspx here].
WiimoteLib is open source and licensed under the MS-Pl.
+
+
+= Implementation =
+
+To compile GiiMote you will need to obtain WiimoteLib from
[http://www.codeplex.com/WiimoteLib CodePlex] and place the library in a
sub-directory of your trunk or root directory called "WiimoteLib"
(ex. "\trunk\WiimoteLib\WiimoteLib.dll").
+
+
+= Links =
+
+ * [http://www.codeplex.com/WiimoteLib WiimoteLib on CodePlex]
+ * [http://brianpeek.com/ Brian Peek's website]
+ * [http://blogs.msdn.com/coding4fun/archive/2007/03/14/1879033.aspx
Coding4Fun article]