README.txt

   1 Welcome to JNode!
   2
   3 Version: $Id$
   4
   5 In this file, you find the instructions needed to setup a JNode development environment.
   6
   7 Sub-Projects
   8 ------------
   9
  10 JNode has been divided into several sub-projects in order to keep it "accessible". These sub-projects are:
  11
  12 JNode-All   The root project where everything comes together
  13 JNode-Core  The core java classes, the Virtual Machine, the OS kernel and the Driver framework
  14 JNode-FS    The Filesystems and the various block device drivers
  15 JNode-GUI   The AWT implementation and the various video & input device drivers
  16 JNode-Net   The Network implementation and the various network device drivers
  17 JNode-Shell The Command line shell and several system commands
  18
  19 Each sub-project has the same directory structure:
  20
  21 <subprj>/build       All build results
  22 <subprj>/descriptors All plugin descriptors
  23 <subprj>/lib         All sub-project specific libraries
  24 <subprj>/src         All sources
  25 <subprj>/.classpath  The eclipse classpath file
  26 <subprj>/.project    The eclipse project file
  27 <subprj>/build.xml   The Ant buildfile
  28
  29 Eclipse
  30 -------
  31
  32 JNode is usually developed in Eclipse. (It can be done without)
  33 The various sub-projects must be imported into eclipse. Since they reference each other, it is advisably to import them in the following order:
  34
  35 1) JNode-Core
  36 2) JNode-Shell
  37 3) JNode-FS
  38 4) JNode-GUI
  39 5) JNode-Net
  40 6) JNode-Builder
  41 7) JNode-All
  42
  43 Building
  44 --------
  45
  46 Execute:
  47
  48 On Windows:  build.bat cd-x86-lite
  49 On Linux:    build.sh cd-x86-lite
  50
  51 Or in Eclipse, execute the "cd-x86-lite" target of all/build.xml.
  52
  53 The build will result in the following files:
  54
  55 all/build/cdroms/jnode-x86-lite.iso         bootable CD image
  56 all/build/cdroms/jnode-x86-lite.iso.vmx     VMWare configuration file
  57
  58 Questions
  59 ---------
  60
  61 If you have any questions, please post them to the forums at www.jnode.org
  62 or to the IRC channel #JNode.org@irc.oftc.net
  63
  64  -- The JNode Team --
  65