f4pga-examples

History

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
..
btn_counter	Update README.md files	2020-09-07 12:36:46 +02:00
README.rst	Change README Markdown format to reStructuredText	2020-09-09 13:25:50 +02:00
environment.yml	Update README.md files	2020-09-07 12:36:46 +02:00
requirements.txt	Update README.md files	2020-09-07 12:36:46 +02:00

README.rst

SymbiFlow Toolchain Examples for QuickLogic EOS S3
==================================================

#. ``btn_counter`` - simple 4-bit counter driving LEDs. The design targets the `EOS S3 FPGA <https://www.quicklogic.com/products/eos-s3/>`__.

Setting up the toolchain
------------------------

.. toolchain_include_begin_label

.. code:: bash

        export INSTALL_DIR="/opt/symbiflow/eos-s3"
        bash conda_installer.sh -b -p $INSTALL_DIR/conda && rm conda_installer.sh
        source "$INSTALL_DIR/conda/etc/profile.d/conda.sh"
        conda env create -f eos-s3/environment.yml
        conda activate eos-s3
        wget -qO- https://quicklogic-my.sharepoint.com/:u:/p/kkumar/Eb7341Bq-XRAukVQ6oQ6PrgB-qdFbrsrPEON1yTa4krFSA?download=1 | tar -xJ -C $INSTALL_DIR
        cp -r $INSTALL_DIR/conda/envs/eos-s3/share/yosys/* $INSTALL_DIR/conda/envs/eos-s3/share/
        conda deactivate

.. toolchain_include_end_label

Building the examples
---------------------

.. build_examples_include_begin_label

Before building example, prepare environment:

.. code:: bash

        export INSTALL_DIR="/opt/symbiflow/eos-s3"
        export PATH="$INSTALL_DIR/install/bin:$PATH"
        source "$INSTALL_DIR/conda/etc/profile.d/conda.sh"
        conda activate eos-s3

        git clone https://github.com/SymbiFlow/symbiflow-examples && cd symbiflow-examples

To build the example, run the following command:

.. code:: bash

        pushd eos-s3/btn_counter && make && popd

.. build_examples_include_end_label