oooooooooooo oooooooooo.         .o.       ooooo                   .o8
`888'     `8 `888'   `Y8b       .888.      `888'                  "888
 888          888      888     .8"888.      888          .oooo.    888oooo.
 888oooo8     888      888    .8' `888.     888         `P  )88b   d88' `88b
 888    "     888      888   .88ooo8888.    888          .oP"888   888   888
 888       o  888     d88'  .8'     `888.   888       o d8(  888   888   888
o888ooooood8 o888bood8P'   o88o     o8888o o888ooooood8 `Y888""8o  `Y8bod8P'

                                           Networked Embedded Systems
                                                  www.edalab.it


oooooooooooo  .oooooo..o oooooooooo.        .oooooo.
`888'     `8 d8P'    `Y8 `888'   `Y8b      d8P'  `Y8b
 888         Y88bo.       888      888    888           oooo d8b  .ooooo.  oooo  oooo  oo.ooooo.
 888oooo8     `"Y8888o.   888      888    888           `888""8P d88' `88b `888  `888   888' `88b
 888    "         `"Y88b  888      888    888     ooooo  888     888   888  888   888   888   888
 888       o oo     .d8P  888     d88'    `88.    .88'   888     888   888  888   888   888   888
o888ooooood8 8""88888P'  o888bood8P'       `Y8bood8P'   d888b    `Y8bod8P'  `V88V"V8P'  888bod8P'
                                                                                        888
                                                  Electronic Systems Design Group      o888o
                                                         esd.sci.univr.it


####################################
#            Contents              #
####################################

<TOC>
1. What this is.
2. Contacts.
3. License.
4. Required libraries.
5. Howto compile.
</TOC>


####################################
# 1. What this is.                 #
####################################


This readme file refers to the SystemC Network Simulation Library ( SCNSL ),
which is a simulator of Networked Embedded Systems.


####################################
# 2. Contacts.                     #
####################################

Please report suggestions, request, bugs at the following addresses.
If you like more support, please check the site wiki or write to us.

Site: scnsl.sourceforge.net

Francesco Stefanni: francesco.stefanni@univr.it
Davide Quaglia: davide.quaglia@univr.it


####################################
# 3. License.                      #
####################################


SCNSL is released under the LGPL v.3 license.
Thus users are NOT forced to release as open source their projects files
binded to SCNSL.
Please check LICENSE.txt and COPYRIGHT.txt files
for mode informations.



####################################
# 4. Required libraries.           #
####################################


In order to compile and use SCNSL, the followings are required:

- SystemC 2.1 or newer.
- SystemC 2.0.
- CMake.
- A C++ compiler and a linker.


####################################
# 5. Howto compile.                #
####################################


Before compiling running CMake, it's required to set these variables in the environment.

- SYSTEMC_DIR: to the path of the SystemC installation.
- TLM_DIR: to the path of the SystemC TLM installation.

For semplicity sake, it is possible to set these paths into the
scripts/env_setup.sh script, and then to source it.

To compile the SCNSL library:

1) Create a directory, and go into it:

> mkdir obj
> cd obj

2) Run CMake, with the path to this directory:

> cmake ..

3) Configure CMake:

> ccmake ..

4) Compile using the environment system. For instance:

> make

5) Generate documentation. For instance:

> make doc

5) Install the library and the documentation. For instance:

> make install

Examples are NOT compiled by running previous steps.
To compile and install them, run similar commands inside the test directory.
Output library will be placed in to the lib directory (relative headers into the include directory),
while the example executable will be placed into the bin directory.
Please remember to add to the LD_LIBRARY_PATH environment variable the directory into which is
located the SCNSL library in order to run the example.

<EOF>
