====== Downloading and Building the public branch of UNISIM svn repository ======

The public branch is intended to be used with the [[http://subversion.tigris.org|subversion]] version control system. To access this svn repository it requires that you have a UNISIM account, or that you use the guest account:
  * **login**: "guest"
  * **password**: (no password required)
\\
Some tarball are also available for those who do not use subversion. However we highly recommend to use subversion, as it will allow you to update in case of a bugfix for instance.

===== Downloading using Subversion =====

For a detailed documentation of subversion, refer to http://svnbook.red-bean.com. In this page we'll just describe the minimum needed to get and build the public branch of the repository.

=== Getting the public branch for the first time ===

To download the whole branch, you can use:
  svn co https://unisim.org/svn/public
It will download the whole branch as a ''pulbic'' folder in the current directory.

=== Updating your branch with new updates from UNISIM ===

To update your branch with new updates from the UNISIM website you can from the public folder you got run the comand:

  svn up

You will be updated to the latest release.



===== Downloading using Tarballs =====

Tar-balls are not available yet, but we plan to have some nightly public source branch pretty soon...







===== What's in the public branch =====

Every thing in the public folder of the repository is open-source software. 
The tree below describe the file tree, including the license of each subtree.

Details on licenses can be found in the LICENCE files of the corresponding 
subtrees.


  * ''public''
    * ''engine ................ : UNISIM core engine used by generated simulators (BSD)''
    * ''components ............ : Components used to build simulators''
      * ''Capabilities ....... : Functionalities beyond timing (BSD)''
      * ''CycleLevel ......... : Components used in cycle-level simulators (BSD)''
        * ''packages ........ : Cycle level modules composing generated simulators''
        * ''simulators ...... : Cycle level simulators''
    * ''tools ................. : Standalone tools''
      * ''CrossCompilers ..... : Cross compilers used to compile simulated benchmarks (unlicensed)''
      * ''GenISSLib .......... : Instruction Set Simulator Generator (GPL)''
      * ''SimFloat++ ......... : Floating-point computation library (LGPL)''



===== Building the public branch =====

On the "public" top-level directory you can use:
  
     ./configure --prefix=/where/to/copy/files
     make

to build up the whole UNISIM environment, including the UNISIM engine, the GenISSLib 
generator, and the SimFloat library. Running make will install those framework 
components in the directory specified by the --prefix option.

The <installation prefix>/bin should be in your path.