.. _user_guide:

User Guide
===============================================================================

.. toctree::
   :hidden:

   Introduction <introduction>
   Git repository <git_repository>
   Releases <releases>
   Build an HDL project <build_hdl>
   HDL architecture <architecture>
   IP cores <ip_cores>
   Porting reference designs <porting_project>
   Customize HDL projects <customize_hdl>
   HDL coding guideline <hdl_coding_guideline>
   Documentation guidelines <docs_guidelines>
   Third party forks <third_party>

`Analog Devices, Inc.`_ provides FPGA reference designs for selected hardware
featuring some of our products interfacing to publicly available FPGA
evaluation boards.

This wiki documentation explains the HDL resources of these reference designs.

Contents
-------------------------------------------------------------------------------

#. :ref:`introduction`
#. :ref:`git_repository`: Our HDL GitHub repository
#. :ref:`releases`: Releases and supported tool versions
#. :ref:`build_hdl`: Building and generating the programming files
#. :ref:`architecture`: HDL project architecture explained
#. :ref:`ip_cores`: List of IP cores
#. :ref:`porting_project`: How to port a project to a non-supported carrier
#. :ref:`customize_hdl`: Using and modifying the HDL design
#. :ref:`hdl_coding_guideline`: The Verilog/VHDL coding guidelines that the
   HDL team is following
#. :ref:`docs_guidelines`: Documentation guidelines
#. :ref:`third_party`: Third party forks with derived work
#. :dokuwiki:`Reference designs using AMD Xilinx hardware <resources/alliances/xilinx>`
#. :dokuwiki:`Reference designs using Intel hardware <resources/alliances/altera>`

.. _Analog Devices, Inc.: https://www.analog.com/en/index.html