coelner/fomu-toolchain
1
0
Fork 0
mirror of https://github.com/im-tomu/fomu-toolchain.git synced 2024-09-20 02:40:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
umarcor 2020-10-12 03:20:14 +02:00
parent 00e028bcc8
commit 968043db68
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -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:
* [open-tool-forge/fpga-toolchain](https://github.com/open-tool-forge/fpga-toolchain):
* **yosys** -- synthesis
* **nextpnr-ice40** -- place-and-route
* **ghdl-yosys-plugin** -- VHDL frontend for Yosys
* **nextpnr** -- place-and-route
* **dfu-util** -- upload bitstream to the FPGA
* **python3** -- required for `nextpnr-ice40` and to build litex projects
* **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.
It is strongly recommended that you install `git` for managing repositories and checking out code, though it is not strictly necessary.