From a32acf7ea896dd8bbd1dfc1602be75ad06e4c40f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fahrican=20Ko=C5=9Far?= Date: Sat, 9 Jan 2021 20:09:46 +0000 Subject: [PATCH] fix typos MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fahrican Koşar --- docs/building-examples.rst | 6 +++--- docs/getting-symbiflow.rst | 8 ++++---- docs/running-examples.rst | 14 +++++++------- xc7/linux_litex_demo/README.rst | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/building-examples.rst b/docs/building-examples.rst index 835865e..3e7b0e2 100644 --- a/docs/building-examples.rst +++ b/docs/building-examples.rst @@ -9,7 +9,7 @@ set it to earlier, for example: export INSTALL_DIR=~/opt/symbiflow -Select your fpga family: +Select your FPGA family: .. tabs:: @@ -27,7 +27,7 @@ Select your fpga family: FPGA_FAM="eos-s3" -Next, prepare the enviroment: +Next, prepare the environment: .. code-block:: bash :name: conda-prep-env @@ -35,7 +35,7 @@ Next, prepare the enviroment: export PATH="$INSTALL_DIR/$FPGA_FAM/install/bin:$PATH"; source "$INSTALL_DIR/$FPGA_FAM/conda/etc/profile.d/conda.sh" -Finally, enter your working Conda enviroment: +Finally, enter your working Conda environment: .. code-block:: bash :name: conda-act-env diff --git a/docs/getting-symbiflow.rst b/docs/getting-symbiflow.rst index 03cafbf..f9d4fb9 100644 --- a/docs/getting-symbiflow.rst +++ b/docs/getting-symbiflow.rst @@ -1,8 +1,8 @@ Getting SymbiFlow ================= -This section describe how to install SymbiFlow and setup a fully working -enviroment to later build example desings. +This section describes how to install SymbiFlow and set up a fully working +environment to later build example designs. Prerequisites ------------- @@ -98,7 +98,7 @@ Select your target FPGA family: export FPGA_FAM=eos-s3 -Next, setup Conda and your system's enviroment: +Next, setup Conda and your system's environment: .. code-block:: bash :name: conda-setup @@ -129,7 +129,7 @@ Download architecture definitions: wget -qO- https://quicklogic-my.sharepoint.com/:u:/p/kkumar/EWuqtXJmalROpI2L5XeewMIBRYVCY8H4yc10nlli-Xq79g?download=1 | tar -xJ -C $INSTALL_DIR/eos-s3/ -If the above commands exited without errors, you have successfuly installed and configured your working enviroment. +If the above commands exited without errors, you have successfully installed and configured your working environment. Build Example Designs --------------------- diff --git a/docs/running-examples.rst b/docs/running-examples.rst index 400eae7..eeb6e36 100644 --- a/docs/running-examples.rst +++ b/docs/running-examples.rst @@ -1,7 +1,7 @@ Running example designs ======================== -This section desribes how to properly connect your board. +This section describes how to properly connect your board. It also helps you configure and run any other software that is necessary to observe results. Connecting development boards @@ -10,7 +10,7 @@ Connecting development boards Arty board ~~~~~~~~~~ -#. Connect the board to your computer using the USB cable: +#. Connect the board to your computer using the USB cable #. Connect the board to your computer using the Ethernet cable (only if you want to test the LiteX Linux Example) @@ -151,7 +151,7 @@ Prepare SD card #. Format the SD card by following the `official guide `_. -#. Download and extract pre-built U-boot images +#. Download and extract pre-built U-boot images: .. code-block:: bash @@ -160,21 +160,21 @@ Prepare SD card wget -qO- https://github.com/SymbiFlow/symbiflow-xc7z-automatic-tester/releases/download/v1.0.0/uboot-linux-images.zip | bsdtar -xf- popd -#. Copy U-boot images to the boot mountpoint +#. Copy U-boot images to the boot mountpoint: .. code-block:: bash cp uboot-linux-images/boot/* /path/to/mountpoint/boot/ sync -#. Copy Arch Linux to the root mountpoint +#. Copy Arch Linux to the root mountpoint: .. code-block:: bash wget -qO- http://de5.mirror.archlinuxarm.org/os/ArchLinuxARM-armv7-latest.tar.gz | sudo tar -xvzC /path/to/mountpoint/root sync -#. Copy additional files and binaries to the root directory in the Arch Linux filesystem +#. Copy additional files and binaries to the root directory in the Arch Linux filesystem: .. code-block:: bash @@ -187,7 +187,7 @@ Prepare SD card .. note:: - ``/path/to/mountpoint/root`` contains the Arch Linux FileSystem, while ``/path/to/mountpoint/root/root/`` is a directory within the FileSystem itself. + ``/path/to/mountpoint/root`` contains the Arch Linux filesystem, while ``/path/to/mountpoint/root/root/`` is a directory within the filesystem itself. .. warning:: diff --git a/xc7/linux_litex_demo/README.rst b/xc7/linux_litex_demo/README.rst index cee6aa9..a0d2368 100644 --- a/xc7/linux_litex_demo/README.rst +++ b/xc7/linux_litex_demo/README.rst @@ -1,7 +1,7 @@ Linux LiteX demo ~~~~~~~~~~~~~~~~ -This example design features a Linix-capable SoC based around VexRiscv soft +This example design features a Linux-capable SoC based around VexRiscv soft CPU. It also includes DDR and Ethernet controllers. To build the litex example, run the following commands: