openFPGALoader/doc/index.rst

openFPGALoader: universal utility for programming FPGA
######################################################

Welcome to the documentation of openFPGALoader!

openFPGALoader is a universal utility for programming FPGAs.
Compatible with many boards, cables and FPGA from major manufacturers (Xilinx, Altera/Intel, Lattice, Gowin, Efinix, Anlogic, Cologne Chip).
openFPGALoader works on Linux, Windows and macOS.

Not sure if your hardware is supported? Check the hardware compatibility lists:

* :ref:`compatibility:fpgas`
* :ref:`compatibility:boards`
* :ref:`compatibility:cables`

Also checkout the vendor-specific documentation:

* `Anlogic <https://trabucayre.github.io/openFPGALoader/vendors/anlogic.html>`__
* `Cologne Chip <https://trabucayre.github.io/openFPGALoader/vendors/colognechip.html>`__
* `Efinix <https://trabucayre.github.io/openFPGALoader/vendors/efinix.html>`__
* `Gowin <https://trabucayre.github.io/openFPGALoader/vendors/gowin.html>`__
* `Intel/Altera <https://trabucayre.github.io/openFPGALoader/vendors/intel.html>`__
* `Lattice <https://trabucayre.github.io/openFPGALoader/vendors/lattice.html>`__
* `Xilinx <https://trabucayre.github.io/openFPGALoader/vendors/xilinx.html>`__

.. toctree::
  :caption: User Guide
  :hidden:

  guide/first-steps
  guide/install
  guide/troubleshooting
  guide/advanced

.. toctree::
  :caption: Compatibility
  :hidden:

  compatibility/fpga
  compatibility/board
  compatibility/cable

.. toctree::
  :caption: Vendors
  :hidden:

  vendors/anlogic
  vendors/colognechip
  vendors/efinix
  vendors/gowin
  vendors/intel
  vendors/lattice
  vendors/xilinx

.. toctree::
  :caption: Development
  :hidden:

  todo