diff --git a/README.md b/README.md index 58106a2..389d5b4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Native FPGA Tools +[![Build](https://github.com/EDAcation/native-fpga-tools/actions/workflows/build.yml/badge.svg)](https://github.com/EDAcation/native-fpga-tools/actions/workflows/build.yml) + Native tool bundles for synthesis & PnR. These bundles are used in [EDAcation](https://github.com/edacation/vscode-edacation) to provide native Yosys & Nextpnr tools without having to download the entire [OSS CAD Suite](https://github.com/YosysHQ/oss-cad-suite-build) tarball. @@ -7,6 +9,7 @@ without having to download the entire [OSS CAD Suite](https://github.com/YosysHQ ## Goals This project has the following main goals: + - **Universal**: The selected tools should be available for the widest possible range of platforms; - **Usable**: Every tool should come with all the necessary dependencies such that no additional setup is required; - **Minimal**: Only the bare minimum should be contained in every tarball for the tool to run, nothing more. @@ -14,6 +17,7 @@ This project has the following main goals: ## Supported Tools & Platforms The following tools are supported: + - `nextpnr-ecp5` - `nextpnr-generic` - `nextpnr-ice40` @@ -21,6 +25,7 @@ The following tools are supported: - `yosys` The following platforms are supported: + - `darwin-arm64` - `darwin-x64` - `linux-arm64` @@ -34,6 +39,7 @@ To get an index of the currently supported tools, issue a GET request to the fol `https://github.com/EDAcation/native-fpga-tools/releases/latest/download/tools.json` The response is a JSON document that looks as follows: + ```json { "version": "2024-07-09", @@ -51,6 +57,7 @@ The response is a JSON document that looks as follows: ``` Downloading the tool will result in a gzipped tarball (`.tgz`, `.tar.gz`) with the following directory structure: + ``` -/ bin/