1********************************************************************
2*                                                                  *
3*  Readme                                                          *
4*                                                                  *
5*  Revolution DWC                                                  *
6*                                                                  *
7********************************************************************
8
91. Introduction
10
11 This is the Revolution DWC 2_0_3_SDK3 package (RVL DWC).
12
13
142. Directory Structure
15
16+build----+-buildtools Files necessary for making a build
17|         +-demos      Demos
18|
19+doc                   Programming manual
20+include               External include files
21+lib                   Library
22+man                   Function Reference
23+tools                 Tools
24
25
263. Making a Build
27
28 A rebuild is not generally necessary because this package includes prebuilt library files (*.a) and demo program executable files (*.elf).
29
30
313.1. Environment Variables
32
33 The following environment variables must be set to build RVL DWC:
34
35REVOLUTION_SDK_ROOT  Revolution SDK root directory
36REVOLUTION_EXT_ROOT  RevoEX library root directory
37CWFOLDER_RVL         CodeWarrior for Revolution directory
38LM_LICENSE_FILE      CodeWarrior license file
39RVLDWC_ROOT          RVLDWC root directory
40
41 In addition, the following path must be added to the environment variable PATH:
42
43PATH=%REVOLUTION_SDK_ROOT%\X86\bin;%CWFOLDER_RVL%\bin;%CYGWIN_PATH%\bin;
44%PATH%
45
46 To simplify these settings, shellrun.bat has been placed in the root directory.
47Running this batch file allows the startup of a shell for which environment variables have been set.
48Edit contents as needed depending on the environment.
49
50
513.2. make Options
52
53 The following options can be specified for make:
54
55- Build target
56
57RVLDWC_DEBUG=TRUE
58RVLDWC_RELEASE=TRUE (default)
59RVLDWC_FINAL=TRUE
60
61 Specifies the build target. The default is "Release build".
62
63
643.3. Preprocessor Directives
65
66The following constants must be defined.
67
68RVL
69
70
713.4. Build Tree
72
73 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.
74
75- build +- demos     +- Each demo program.
76
77
783.5. Checking Operations
79
80 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".
81 To create your own program, see the demo program template (/build/demos/template).
82
83
844. Test Environment
85
86 This package has been built and its operations checked in the following environments:
87
88- Compiler          : CodeWarrior for GameCube Version 3.0 Alpha 5 Patch 2 (2006/09/20)
89- NDEV              : NDEV Version 2.1 (NDEV Software version as of 2007/10/02)
90                    : NDEV Firmware 35.4.16
91- Revolution SDK    : Revolution SDK 3.1 Patch 4
92- RevoEX            : Revolution SDK Extension Ver.2.1
93- Network connection: Internal wireless and USB-Ether (wired) (configured with ncdconfigtool).
94
95
96 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.
97