diff --git a/README.rst b/README.rst index f5675b8..1f8e862 100644 --- a/README.rst +++ b/README.rst @@ -35,21 +35,22 @@ If you have not already done so, clone this repository and ``cd`` into it: Prerequisites ------------- -The only required prerequisite is ``wget``. You can install it using: + +Install the following prerequisites before using symbiflow-examples: * For Ubuntu: .. code:: bash - :name: install-wget-ubuntu + :name: install-req-ubuntu apt update && apt install -y wget * For CentOS: .. code:: bash - :name: install-wget-centos + :name: install-req-centos - yum install -y wget + yum install -y wget which Toolchain installation ---------------------- @@ -159,6 +160,8 @@ To build the litex example, run the following commands: .. code:: bash :name: xc7-litex + mkdir xc7/litex_demo + pushd xc7/litex_demo wget https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py chmod +x litex_setup.py ./litex_setup.py init @@ -167,6 +170,7 @@ To build the litex example, run the following commands: tar -xf riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz export PATH=$PATH:$PWD/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14/bin/ pushd litex/litex/boards/targets && ./arty.py --toolchain symbiflow --cpu-type vexriscv --sys-clk-freq 80e6 --no-ident-version --build && popd + popd To build the linux-litex-demo example, run the following commands: diff --git a/README.src.rst b/README.src.rst index eb6becc..23e8066 100644 --- a/README.src.rst +++ b/README.src.rst @@ -35,21 +35,22 @@ If you have not already done so, clone this repository and ``cd`` into it: Prerequisites ------------- -The only required prerequisite is ``wget``. You can install it using: + +Install the following prerequisites before using symbiflow-examples: * For Ubuntu: .. code:: bash - :name: install-wget-ubuntu + :name: install-req-ubuntu apt update && apt install -y wget * For CentOS: .. code:: bash - :name: install-wget-centos + :name: install-req-centos - yum install -y wget + yum install -y wget which Toolchain installation ---------------------- @@ -69,9 +70,9 @@ This section describes how to install the toolchain. This procedure is divided i 2. Choose the install directory -The install directory can either be in your home directory -such as ``~/opt/symbiflow`` or in a system directory such as ``/opt/symbiflow``. -If you choose a system directory, you will need root permission to perform the installation, +The install directory can either be in your home directory +such as ``~/opt/symbiflow`` or in a system directory such as ``/opt/symbiflow``. +If you choose a system directory, you will need root permission to perform the installation, and so you will need to add some ``sudo`` commands to the instructions below. .. code:: bash diff --git a/xc7/README.rst b/xc7/README.rst index 5941d29..51c9bd5 100644 --- a/xc7/README.rst +++ b/xc7/README.rst @@ -42,7 +42,10 @@ Choose the installation directory (see the `README <../README.rst>`_ one level u conda env create -f xc7/environment.yml conda activate xc7 mkdir -p $INSTALL_DIR/xc7/install - wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/continuous/install/66/20200914-111752/symbiflow-arch-defs-install-05d68df0.tar.xz | tar -xJC $INSTALL_DIR/xc7/install + wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/presubmit/install/1049/20201123-030526/symbiflow-arch-defs-install-05bd35c7.tar.xz | tar -xJC $INSTALL_DIR/xc7/install + mkdir -p $INSTALL_DIR/xc7/install/share/symbiflow/arch + wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/presubmit/install/1049/20201123-030526/symbiflow-xc7a50t_test.tar.xz | tar -xJC $INSTALL_DIR/xc7/install/share/symbiflow/arch + wget -qO- https://storage.googleapis.com/symbiflow-arch-defs/artifacts/prod/foss-fpga-tools/symbiflow-arch-defs/presubmit/install/1049/20201123-030526/symbiflow-xc7a100t_test.tar.xz | tar -xJC $INSTALL_DIR/xc7/install/share/symbiflow/arch conda deactivate .. toolchain_include_end_label @@ -89,6 +92,8 @@ To build the litex example, run the following commands: .. code:: bash :name: xc7-litex + mkdir xc7/litex_demo + pushd xc7/litex_demo wget https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py chmod +x litex_setup.py ./litex_setup.py init @@ -96,7 +101,8 @@ To build the litex example, run the following commands: wget https://static.dev.sifive.com/dev-tools/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz tar -xf riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz export PATH=$PATH:$PWD/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14/bin/ - pushd litex/litex/boards/targets && ./arty.py --toolchain symbiflow --cpu-type vexriscv --build && popd + pushd litex/litex/boards/targets && ./arty.py --toolchain symbiflow --cpu-type vexriscv --sys-clk-freq 80e6 --no-ident-version --build && popd + popd To build the linux-litex-demo example, run the following commands: