Merge pull request #10 from antmicro/update-readme

Update readme

.gitignore

@@ -0,0 +1,2 @@
+build
+env

README.md

@@ -6,12 +6,17 @@ The examples target the Artix-7 devices.
 The repository includes:
 
 * Travis CI configuration file
+* Build scripts to generate the environment:
+  * Conda configurations
+  * Python requirements
+  * Environment setup
+
 * Example FPGA designs including:
 
   * Verilog code
   * Pin constraints files
   * Timing constraints files
-  * Makefiles for running the SymbiFlow toolchain 
+  * Makefiles for running the SymbiFlow toolchain
 
 ## Description
 
@@ -19,7 +24,7 @@ Travis-based CI in this repository runs all the steps required to build the exam
 
 The CI performs the following steps:
 
-* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) installation and configuration 
+* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) installation and configuration
 * Installation of the required conda packages (toolchains and Python modules). Note that Python packages can be installed using any Python package manager:
 
     * [VTR](https://anaconda.org/symbiflow/vtr)
@@ -27,25 +32,19 @@ The CI performs the following steps:
     * [Yosys-plugins](https://anaconda.org/symbiflow/yosys-plugins)
     * [lxml](https://anaconda.org/conda-forge/lxml), [simplejson](https://anaconda.org/conda-forge/simplejson), [intervaltree](https://anaconda.org/conda-forge/intervaltree), [python-constraint](https://anaconda.org/conda-forge/python-constraint), [git](https://anaconda.org/conda-forge/git), [pip](https://anaconda.org/conda-forge/pip) and [fasm](https://github.com/SymbiFlow/fasm)
 
-* Building of example designs
+## Toolchain installation
 
-The example designs are provided in separate directories:
+This block of code regards the toolchain installation. It is divided in three main steps:
 
-1. `counter` - simple 4-bit counter driving LEDs. The design targets the [Basys3 board](https://store.digilentinc.com/basys-3-artix-7-fpga-trainer-board-recommended-for-introductory-users/) .
-1. `picosoc` - [picorv32](https://github.com/cliffordwolf/picorv32) based SoC. The design targets the [Basys3 board](https://store.digilentinc.com/basys-3-artix-7-fpga-trainer-board-recommended-for-introductory-users/).
-1. `linux_litex` - [LiteX](https://github.com/enjoy-digital/litex) based system with Linux capable [VexRiscv core](https://github.com/SpinalHDL/VexRiscv). The design includes [DDR](https://github.com/enjoy-digital/litedram) and [Ethernet](https://github.com/enjoy-digital/liteeth) controllers. The design targets the [Arty board](https://store.digilentinc.com/arty-a7-artix-7-fpga-development-board-for-makers-and-hobbyists/).
-
-The Linux images for the `linux_litex` example can be build following the [linux on litex vexriscv](https://github.com/litex-hub/linux-on-litex-vexriscv) instructions.
-
-The Travis-based CI performs all the necessary steps to build the example designs and generate the bitstreams.
-If you want to manually build the examples, run following commands:
+- Conda setup
+- Conda packages installation
+- Architecture definitions installation
 
 ```bash
-git clone https://github.com/SymbiFlow/symbiflow-examples.git
-cd symbiflow-examples
-wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
-bash miniconda.sh -b -p $HOME/miniconda
-source "$HOME/miniconda/etc/profile.d/conda.sh"
+INSTALL_DIR=/opt/symbiflow
+wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
+bash Miniconda3-latest-Linux-x86_64.sh -b -p $INSTALL_DIR/conda && rm Miniconda3-latest-Linux-x86_64.sh
+source $INSTALL_DIR/conda/etc/profile.d/conda.sh
 conda config --set always_yes yes --set changeps1 no
 conda config --add channels conda-forge
 conda config --add channels symbiflow
@@ -56,9 +55,29 @@ conda install -c symbiflow yosys-plugins
 conda install -c symbiflow vtr=8.0.0.rc2_3575_g253f75b6d
 conda install lxml simplejson intervaltree python-constraint git pip
 pip install git+https://github.com/symbiflow/fasm
-wget "https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/continuous/install/4/20200416-002215/symbiflow-arch-defs-install-a321d9d9.tar.xz"
-tar -xf symbiflow-arch-defs-install-a321d9d9.tar.xz
-export PATH=$PWD/install/bin:$PATH
+wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/continuous/install/4/20200416-002215/symbiflow-arch-defs-install-a321d9d9.tar.xz | tar -xJ -C $INSTALL_DIR
+conda deactivate
+```
+
+## Build Example Designs
+
+With the toolchain installed, you can build the example designs.
+
+The example designs are provided in separate directories:
+
+1. `counter` - simple 4-bit counter driving LEDs. The design targets the [Basys3 board](https://store.digilentinc.com/basys-3-artix-7-fpga-trainer-board-recommended-for-introductory-users/) .
+1. `picosoc` - [picorv32](https://github.com/cliffordwolf/picorv32) based SoC. The design targets the [Basys3 board](https://store.digilentinc.com/basys-3-artix-7-fpga-trainer-board-recommended-for-introductory-users/).
+1. `linux_litex` - [LiteX](https://github.com/enjoy-digital/litex) based system with Linux capable [VexRiscv core](https://github.com/SpinalHDL/VexRiscv). The design includes [DDR](https://github.com/enjoy-digital/litedram) and [Ethernet](https://github.com/enjoy-digital/liteeth) controllers. The design targets the [Arty board](https://store.digilentinc.com/arty-a7-artix-7-fpga-development-board-for-makers-and-hobbyists/).
+
+The Linux images for the `linux_litex` example can be build following the [linux on litex vexriscv](https://github.com/litex-hub/linux-on-litex-vexriscv) instructions.
+The `linux_litex` example is already provided with working Linux images.
+
+To build the examples, run following commands from the project root directory:
+
+```bash
+conda activate
+# adding symbiflow toolchain binaries to PATH
+export PATH=$INSTALL_DIR/install/bin:$PATH
 # counter example
 pushd counter_test && make && popd
 # picosoc example