.. LegUp documentation master file, created by
   sphinx-quickstart on Sat Nov  5 14:49:27 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. Welcome to LegUp's documentation!
.. =================================

LegUp |version| Documentation
==============================

LegUp automatically compiles a C/C++ program into
hardware described in Verilog HDL (Hardware Description Language). The
generated hardware can be programmed onto an Microchip FPGA (Field-Programmable Gate
Array).
Hardware implemented on an FPGA can provide 2-10X performance and power
benefits over the same computation running on regular processors.

.. LegUp includes:

  * C/C++ to Verilog high-level synthesis tool. Tested on Windows/Linux 64-bit.


The documentation is comprised of the following sections:

    * :ref:`getstarted`: Installation and a quick start guide
    * :ref:`userguide`: How to use LegUp to generate hardware
    * :ref:`optimizationguide`: How to optimize the generated hardware
    * :ref:`hwarch`: Synthesized hardware architecture
    * :ref:`constraints`: Constraints manual
    * :ref:`FAQ`: Frequently asked questions

For example applications using LegUp please check out our github at:

    * https://github.com/LegUpComputing/legup-examples

.. Comment out release notes:
    * :ref:`release`: New features and known problems with each release

For support, please contact legup@microchip.com.

.. toctree::
   :numbered:
   :maxdepth: 3

   gettingstarted
   userguide
   optimizationguide
   hwarchitecture
   faq
   pragmas
   constraintsmanual
.. restrictions

.. Comment out:
   releasenotes

.. Indices and tables
.. ==================
..
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`