README

   1 ==============================================================================
   2 Ibex README
   3
   4 ______________________________________________________________________________
   5 Documentation
   6
   7 If you're new to Ibex, you should read the documentation in the order
   8 presented below:
   9
  10 - README [this file]
  11
  12       Start here. Includes a map of all other documentation and a
  13       description of the directory strucure
  14
  15 - The Ibex home page [http://www.ibex.org/]
  16
  17 - The Ibex tutorials [http://www.ibex.org/tutorials.html]
  18
  19       Gentle introduction to what Ibex is, and how to write
  20       .ibex's. Good for anybody who wants to write Ibex applications.
  21
  22 - The Ibex reference [http://www.ibex.org/reference.html]
  23
  24       Precise, technical spec of exactly how Ibex works. Assumes
  25       familiarity with Ibex (ie, you've read the tutorial). This is the
  26       authoritative source for how an Ibex engine should
  27       behave.
  28
  29
  30 ______________________________________________________________________________
  31 Directory Structure
  32
  33 /
  34    AUTHORS                  - people involved in developing Ibex
  35    README                   - this file
  36    COPYING                  - copyright information for all files in this distro
  37    CHANGES                  - the changelot
  38    TM                       - trademark information for Ibex
  39    Makefile                 - build file for gcc 3.3
  40    next.build               - the build id of the next build to be generated
  41
  42    build/                   - anything generated by the build process winds up here
  43          h/                 - header files generated by gcjh
  44          java/              - auto-generated .java source files
  45          class/             - java .class files
  46          xwar/              - generated xwars (mainly builtin.xwar)
  47          mips/              - mips binaries (interpreted on all platforms)
  48          JVM/               - java Jar archives
  49          Linux/             - Linux binaries
  50          Win32/             - Win32 binaries
  51          Darwin/            - Darwin binaries
  52          Solaris/           - Solaris binaries
  53
  54    Makefile.upstream        - build/download/install instructions for upstream packages
  55    upstream/                - download, build, and install area for upstream packages
  56             install/        - this is the --prefix for all configure invocations
  57             gcc-3.3/        - build/download area for gcc
  58             jpeg-6b/        - build/download area for libjpeg
  59             freetype-2.1.4/ - build/download area for freetype
  60             newlib-1.11.0/  - build/download area for newlib
  61             darwin-linker/  - build/download area for a hacked version of Apple's binutils
  62
  63    lib/                     - any third-party binary stuff needed during the build process
  64        javago               - a copy of the javago post-compilation bytecode inliner
  65        jump.jar             - the jump2 bytecode-to-palmos translator
  66        libgcj-minimal.jar   - a tiny portion of libgcj.jar; allows java->bytecode compilation without gcj
  67
  68    src/                     - all java source files and ibex sources go here
  69        edu/stanford/ejalbr  - source code for BrowserLauncher
  70        gnu/regexp/          - source code for the GNU regexp library for Java
  71        org/
  72            bouncycastle/    - the BouncyCastle Crypto Library
  73            ibex/
  74                translators/ - .ibex's and .png's that are essential to bootstrapping the engine
  75                plat/        - platform-specific code
  76                util/        - misc utilities
  77                js/          - the Ibex JavaScript Interpreter
  78                mips/        - the Ibex MIPS interpreter/recompiler
  79                builtin/     - content for the core builtin resource
  80
  81
  82 ______________________________________________________________________________
  83 Build Requirements
  84
  85 There are pre-built, digitally signed binaries on http://dist.ibex.org/
  86 for every supported platform.  Please consider using those unless
  87 you're absolutely certain you need to go through the trouble of trying
  88 to get Ibex to build.
  89
  90 Requirements:
  91     - jdk 1.3+
  92     - the standard set of POSIX utilities (wc, grep, find, make, etc)
  93
  94 Build Targets:
  95     - compile: compiles all .java files into build/class/
  96     - JVM:     Any true Java JVM (ie not GCJ)
  97     - Win32:   Win95 OSR2 or later
  98     - Linux:   Linux 2.2 or later
  99     - Darwin:  Any Darwin-based OS (Mac OS X, OpenDarwin)
 100     - Solaris: Solaris 2.7+
 101     - clean:   always run this after doing a 'cvs update'
 102