.. highlight:: bash

.. _getstarted:

Getting Started
==================

First, `download <http://www.legupcomputing.com/main/download>`_ the LegUp
installer from our website.  We support both Windows (64-bit) and Linux (64-bit).
We recommend Windows 10, CentOS 6/7, or Ubuntu 16.04.

Installation
------------

Windows
++++++++++++++++++++++++++++++++++++

Run the Windows installer program, ``LegUp-9.0-Win64-Setup.exe``, and go through the steps in the installer.

Linux
+++++++++++++++++++++

CentOS
******

The CentOS installer is packaged as a self-extracting shell script that can be installed to a local
directory. To run the installer::

    cd $(INSTALLATION_DIRECTORY)
    sh /path/to/legup-9.0-centos-installer.run

This will install LegUp into the INSTALLATION_DIRECTORY.  After the
installation is completed, please add the LegUp bin directory to your path::

    export PATH=$(INSTALLATION_DIRECTORY)/legup-9.0/legup/bin:$PATH

If you need to extend your license on CentOS, please also set the following environment variable:: 
    
    export LD_LIBRARY_PATH=$(INSTALLATION_DIRECTORY)/legup-9.0/dependencies/gcc/lib64:$LD_LIBRARY_PATH

Libero and ModelSim 
+++++++++++++++++++++

You will need to install the `Libero SoC software
<https://www.microsemi.com/product-directory/design-resources/1750-libero-soc>`_
to synthesize the generated hardware for Microchip FPGAs.
Libero also comes with ModelSim which is used by LegUp to simulate the
generated Verilog. 

Please note that the first time you simulate with a generated hardware block with fresh install of LegUp, ModelSim will compile our IP libraries, which may take some time.

.. _quick_start:

Quick Start Tutorial
-----------------------

Please refer to our `LegUp HLS Tutorial for Microsemi PolarFire: Sobel Filtering for Image Edge Detection` on how to use some of the major features and optimization techniques.