README

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