********************************************************************
*                                                                  *
*  Readme                                                          *
*                                                                  *
*  Revolution DWC                                                  *
*                                                                  *
********************************************************************

1. Introduction

 This is the Revolution DWC 2_0_3_SDK3 package (RVL DWC). 


2. Directory Structure

+build----+-buildtools Files necessary for making a build
|         +-demos      Demos
|
+doc                   Programming manual
+include               External include files
+lib                   Library
+man                   Function Reference
+tools                 Tools


3. Making a Build

 A rebuild is not generally necessary because this package includes prebuilt library files (*.a) and demo program executable files (*.elf).


3.1. Environment Variables

 The following environment variables must be set to build RVL DWC:

REVOLUTION_SDK_ROOT  Revolution SDK root directory
REVOLUTION_EXT_ROOT  RevoEX library root directory
CWFOLDER_RVL         CodeWarrior for Revolution directory
LM_LICENSE_FILE      CodeWarrior license file
RVLDWC_ROOT          RVLDWC root directory

 In addition, the following path must be added to the environment variable PATH:

PATH=%REVOLUTION_SDK_ROOT%\X86\bin;%CWFOLDER_RVL%\bin;%CYGWIN_PATH%\bin;
%PATH%

 To simplify these settings, shellrun.bat has been placed in the root directory.
Running this batch file allows the startup of a shell for which environment variables have been set.
Edit contents as needed depending on the environment.


3.2. make Options

 The following options can be specified for make:

- Build target

RVLDWC_DEBUG=TRUE
RVLDWC_RELEASE=TRUE (default)
RVLDWC_FINAL=TRUE

 Specifies the build target. The default is "Release build".


3.3. Preprocessor Directives

The following constants must be defined.
  
RVL


3.4. Build Tree

 The makefile in this package has a hierarchical structure so that running make at the top of the hierarchy also makes targets at lower levels.

- build +- demos     +- Each demo program.


3.5. Checking Operations

 To check operations at the outset, run "shellrun.bat", which is included in the root directory. Go to the demo program directory (/build/demos/bin/) on the console and run "ndrun <program_name>.elf".
 To create your own program, see the demo program template (/build/demos/template).


4. Test Environment

 This package has been built and its operations checked in the following environments:

- Compiler          : CodeWarrior for GameCube Version 3.0 Alpha 5 Patch 2 (2006/09/20)
- NDEV              : NDEV Version 2.1 (NDEV Software version as of 2007/10/02)
                    : NDEV Firmware 35.4.16
- Revolution SDK    : Revolution SDK 3.1 Patch 4
- RevoEX            : Revolution SDK Extension Ver.2.1
- Network connection: Internal wireless and USB-Ether (wired) (configured with ncdconfigtool).


 Builds of this package may not function in environments different from those listed above. Specifically, different versions of Revolution SDK, Socket in the RevoEX and NDEV hardware and firmware can have adverse effects on the operation.