From 968043db684af99f43940b1dfcb029c9a9740ae4 Mon Sep 17 00:00:00 2001 From: umarcor Date: Mon, 12 Oct 2020 03:20:14 +0200 Subject: [PATCH] update README.md --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5b0964e..b121b71 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,31 @@ # Fomu Toolchain -Fomu is an FPGA in your USB port. This repository contains prebuilt versions of all the tools you will need to develop for Fomu. +[Fomu](https://github.com/im-tomu/fomu-hardware) ([fomu.im](https://fomu.im)) is an FPGA in your USB port. This repository gathers all the tools you will need to develop for Fomu, and provides them as prebuilt packages for GNU/Linux, Windows or macOS. ## Usage Download the [latest release](https://github.com/im-tomu/fomu-toolchain/releases/latest) for your platform and extract it somewhere on your disk. Then set your PATH: -* MacOS: `export PATH=[path-to-bin]:$PATH` -* Linux: `export PATH=[path-to-bin]:$PATH` -* Windows Powershell: `$ENV:PATH = "[path-to-bin];" + $ENV:PATH` -* Windows cmd.exe: `PATH=[path-to-bin];%PATH%` +* Shell (GNU/Linux, Cygwin/MSYS2/MINGW, MacOS...): `export PATH=[path-to-bin]:$PATH` +* Powershell (Windows): `$ENV:PATH = "[path-to-bin];" + $ENV:PATH` +* cmd.exe (Windows): `PATH=[path-to-bin];%PATH%` To confirm installation, run a command such as `nextpnr-ice40` or `yosys`. ## What's included -This contains _almost_ everything you'll need to develop on Fomu: +Prebuilt packages contain _almost_ everything you'll need for developing software and/or hardware on Fomu: -* **yosys** -- synthesis -* **nextpnr-ice40** -- place-and-route -* **dfu-util** -- upload bitstream to the FPGA -* **python3** -- required for `nextpnr-ice40` and to build litex projects -* **riscv-gcc** -- compile code for RISC-V CPUs, such as the Fomu softcore -* **wishbone-tool** -- access the debug bus on Fomu +* [open-tool-forge/fpga-toolchain](https://github.com/open-tool-forge/fpga-toolchain): + * **yosys** -- synthesis + * **ghdl-yosys-plugin** -- VHDL frontend for Yosys + * **nextpnr** -- place-and-route + * **dfu-util** -- upload bitstream to the FPGA + * **python3** -- required for `nextpnr-ice40` and for building litex projects + * Find the list of all tools at [open-tool-forge/fpga-toolchain: Introduction](https://github.com/open-tool-forge/fpga-toolchain#introduction). +* Extras, specific for Fomu: + * **riscv-gcc** -- compile code for RISC-V CPUs, such as the Fomu softcore + * **wishbone-tool** -- access the debug bus on Fomu + * The Windows version includes `make` and `teraterm`. -Additionally, the macOS and Windows versions include `make`. - -It is strongly recommended that you install `git` to manage repositories and check out code, though it is not strictly necessary. \ No newline at end of file +It is strongly recommended that you install `git` for managing repositories and checking out code, though it is not strictly necessary.