Example designs showing different ways to use F4PGA toolchains.
Go to file
Kamil Rakoczy 045dc79d4f Change README Markdown format to reStructuredText
This commit is workaround for Github not rendering
`.. include::`.

This PR adds:
 - Adds Makefile for creating conda environment under `env/conda` and
   installs `rst_include` tool.

 - Adds make README.rst target to generate `README.rst` from `README.src.rst`

 - Has Travis CI run on repository and check that the `README.rst` file
   has been rebuilt and committed if any of the dependencies have
   change.

Signed-off-by: Kamil Rakoczy <krakoczy@antmicro.com>
2020-09-09 13:25:50 +02:00
.github/travis Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
eos-s3 Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
scripts/make Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
xc7 Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
.gitattributes update gitattributes 2020-06-09 22:16:32 +02:00
.gitignore Added gitignore 2020-05-26 19:43:20 +02:00
.travis.yml Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
LICENSE Add LICENSE 2020-04-21 14:58:08 +02:00
Makefile Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
README.rst Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
README.src.rst Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
environment.yml Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00
requirements.txt Change README Markdown format to reStructuredText 2020-09-09 13:25:50 +02:00

README.src.rst

SymbiFlow examples
==================

This repository provides example FPGA designs that can be built using the SymbiFlow open source toolchain.
The examples target the Xilinx Artix-7 and the QuickLogic EOS S3 devices.

The repository includes:

* `eos-s3 </eos-s3>`_ - Example FPGA designs for the QuickLogic EOS S3 series of parts:

  * Verilog code
  * Pin constraints files
  * Timing constraints files
  * Makefiles for running the SymbiFlow toolchain

* `xc7 </xc7>`_ - Example FPGA designs for the Xilinx 7 series of parts:

  * Verilog code
  * Pin constraints files
  * Timing constraints files
  * Makefiles for running the SymbiFlow toolchain

* `.travis.yml <.travis.yml>`_ - Travis CI configuration file

Toolchain installation
----------------------

This section describes how to install the toolchain. This procedure is divided in two steps:

- Installing the Conda package manager
- Downloading the architecture definitions and installing the toolchain

#. Conda

.. code:: bash

        wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O conda_installer.sh

#. Toolchain

* For the Artix-7 devices:

.. include:: xc7/README.rst
   :start-after:.. toolchain_include_begin_label
   :end-before:.. toolchain_include_end_label


* For the EOS S3 devices:

.. include:: eos-s3/README.rst
   :start-after:.. toolchain_include_begin_label
   :end-before:.. toolchain_include_end_label

Build Example Designs
---------------------

With the toolchain installed, you can build the example designs.
The example designs are provided in separate directories:

* ``xc7`` directory for the Artix-7 devices
* ``eos-s3`` directory for the EOS S3 devices

Example designs for the Artix-7 devices:
****************************************

* For the Artix-7 devices:

.. include:: xc7/README.rst
   :start-after:.. build_examples_include_begin_label
   :end-before:.. build_examples_include_end_label

Example design for the EOS S3 devices:
**************************************

* For the EOS S3 devices:

.. include:: eos-s3/README.rst
   :start-after:.. build_examples_include_begin_label
   :end-before:.. build_examples_include_end_label