contents.xml

   1 <contents>
   2 <description>
   3 <p>The root directory of AROS contains this:</p>
   4 </description>
   5
   6 <item>
   7     <file>_gdbinit</file>
   8     Init file for the GNU Debugger gdb.
   9 </item>
  10 <item>
  11     <file>aclocal.m4</file>
  12     Local macros for GNU autoconf.
  13 </item>
  14
  15 <item>
  16     <dir>bin</dir>
  17     This directory contains all generated files under the name of
  18     your OS (eg. <filename>AROS/bin/linux/</filename>). This directory is
  19     called <shell>$(ARCHDIR)</shell>. Below this are two more directories:
  20     <shell>$(BINDIR)</shell> where the files should be put which the end user
  21     should see and <shell>$(GENDIR)</shell> where you can create a directory to
  22     put all files one part of AROS needs (eg. <filename>libs/</filename> or
  23     <filename>os/</filename>). The directory <shell>$(OSGENDIR)</shell> is below
  24     <shell>$(GENDIR)</shell> and all <filename>*.o</filename> files in this directory are
  25     collected to the <filename>AmigaOS.lib</filename>.
  26 </item>
  27
  28 <item>
  29     <dir>compiler</dir>
  30     The C compiler for AROS. It contains include files, the source for
  31     amiga.lib and c.lib and the source for the compiler and all compiler
  32     specific utilities.
  33 </item>
  34
  35 <item>
  36     <dir>config</dir>
  37     This directory contains the dirty stuff. Code which makes AROS
  38     live (mostly hacked up assembler code which you don't want to see).
  39     Anything is allowed inside this directory in order to make AROS
  40     work on as many hardwares as possible.
  41 </item>
  42
  43 <item>
  44     <file>configure</file>
  45     This is a script which examines your system and creates a file
  46     named <filename>AROS/config/host.cfg</filename> which is used by the
  47     makefiles. Run <shell>autoconf</shell> if it doesn't exist.
  48 </item>
  49
  50 <item>
  51     <file>configure.in</file>
  52     Source file. Run autoconf to convert this into a configure script.
  53 </item>
  54
  55 <item>
  56     <dir>docs</dir>
  57     The source for the documentation.
  58 </item>
  59
  60 <item>
  61     <file>license.html</file>
  62     Our copyright license
  63 </item>
  64
  65 <item>
  66     <dir>local</dir>
  67     This directory and it's contents are ignored by AROS. You can
  68     put alpha stuff here if you want to avoid CVS complaining about
  69     it.
  70 </item>
  71
  72 <item>
  73     <file>make.defaults</file>
  74     File with options for the make. If you want to change an option, create a
  75     file <filename>make.opts</filename> and put your changes there. The most
  76     simple method is just to copy <filename>make.defaults</filename> to
  77     <filename>make.opts</filename>.
  78 </item>
  79
  80 <item>
  81     <file>make.defaults.in</file>
  82     This file is used by configure to create
  83     <filename>make.defaults</filename>.
  84 </item>
  85
  86 <item>
  87     <file>mmake.config</file>
  88     Config file for MetaMake
  89 </item>
  90
  91 <item>
  92     <file>mmake.config.in</file>
  93     This file is used by configure to create
  94     <filename>mmake.config</filename>.
  95 </item>
  96
  97 <item>
  98     <file>mmakefile</file>
  99     This is the magic file which holds the whole thing together.
 100     It has the following rules:
 101
 102     <filtermakefile>target</filtermakefile>
 103 </item>
 104
 105 <item>
 106     <dir>rom</dir>Things which are internal parts of the OS.
 107 </item>
 108
 109 <item>
 110     <dir>scripts</dir>Scripts which are used to generate code.
 111 </item>
 112
 113 <item>
 114     <dir>test</dir>Testsuite for AROS.
 115 </item>
 116
 117 <item>
 118     <dir>tools</dir>This contains build tools.
 119 </item>
 120
 121 <item>
 122     <dir>workbench</dir>The disk-based part of AROS.
 123 </item>
 124
 125 </contents>