Skip to content

Commit

Permalink
Add badge to README
Browse files Browse the repository at this point in the history
  • Loading branch information
malmeloo committed Sep 28, 2024
1 parent 0a500a2 commit 5289ee5
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
# 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.

## 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.

## Supported Tools & Platforms

The following tools are supported:

- `nextpnr-ecp5`
- `nextpnr-generic`
- `nextpnr-ice40`
- `nextpnr-nexus`
- `yosys`

The following platforms are supported:

- `darwin-arm64`
- `darwin-x64`
- `linux-arm64`
Expand All @@ -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",
Expand All @@ -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:

```
<platform>-<tool-name>/
bin/
Expand Down

0 comments on commit 5289ee5

Please sign in to comment.