---------------------------------------------------------------------------
                               README
---------------------------------------------------------------------------

What is this?
-------------

The archive includes a Debian system (with proper compiler and tools),
along with NS2 sources, and OLSR patches plus Dang's OLSR fixes.

The idea is to run a Debian system in a subdirectory so that you
are able to recompile NS2+OLSR patches on any/most Linux systems.


How to install
--------------

You should have got an archive Debian-NS2-OLSRv3-xxx.tar.gz
Just extract the it with a command like:
  tar xzvpf Debian-NS2-OLSRv3-xxx.tar.gz
(if you are not root, you'll get some errors/warnings, but it should still 
work later)
Then go into directory Debian-NS2-OLSRv3-xxx, and see section "Running it"

Where are NS2 sources?
----------------------

NS2 is extracted, patched with OLSR, compiled, the first tome
you start it - it ends up in the directory /home/olsr of the
Debian system, that is, in Debian-NS2-OLSRv3-xxx/DebianWoody/home/olsr
when you extracted this archive.


Running it
----------

It runs by two ways:
* via chroot. You need to be root.
* via UserModeLinux. You can be user but it will be slower.

If you don't know what they are, please, go on <http://user-mode-linux.sf.net/>
for UserModeLinux, or refer to Unix/Linux documentation.

You can start each way by two scripts:
* being root: goDebianRoot.sh:
    ./goDebianRoot.sh
* staying user: goDebianUserModeLinux.sh
    ./goDebianUserModeLinux.sh

The first time the Debian system is started, the
extraction/patching/compilation is done. After that, the compilation
should not be done again, and now you have ns2, so you are on your own.
See section "Where are NS2 sources?".

In any case, be sure you understand and change properly the security rights
of Debian-NS2-OLSRv3-xxx/DebianWoody/home/olsr and the files inside.

---------------------------------------------------------------------------

The files are copyright by their owners:
- Debian system: the copyrights of installed packages of Debian
- NS2: copyright of NS2
- OLSR-for-NS2 patch: BSD-like license.

Source files:

* The DebianWoody files come from:
  "debootstrap woody DebianWoody" done on a Debian/unstable.
  this results into installation of Debian files, the sources being
  available at <http://www.debian.org/>

* linux UML kernel comes from

http://kernels.usermodelinux.org/kernels/linux-2.4.22-djc2-8um/nomods/linux
the config/patchs/sources are available at http://kernels.usermodelinux.org/

See also:
http://umn.dl.sourceforge.net/sourceforge/user-mode-linux/linux-2.4.19-5.bz2
the sources are available at <http://user-mode-linux.sf.net/>

---------------------------------------------------------------------------