Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
whitequark committed Mar 15, 2024
1 parent e10d1ad commit 4a12946
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,23 @@ See the [Introduction](https://amaranth-lang.org/docs/amaranth/latest/intro.html

See the [Installation](https://amaranth-lang.org/docs/amaranth/latest/install.html) section of the documentation.

## Supported devices
## Usage

See the [Language guide](https://amaranth-lang.org/docs/amaranth/latest/guide.html) section of the documentation.

## Platform support

Amaranth can be used to target any FPGA or ASIC process that accepts behavioral Verilog-2001 as input. It also offers extended support for many FPGA families, providing toolchain integration, abstractions for device-specific primitives, and more. Specifically:

* Lattice iCE40 (toolchains: **Yosys+nextpnr**, LSE-iCECube2, Synplify-iCECube2);
* Lattice MachXO2 (toolchains: Diamond);
* Lattice MachXO3L (toolchains: Diamond);
* Lattice ECP5 (toolchains: **Yosys+nextpnr**, Diamond);
* Xilinx Spartan 3A (toolchains: ISE);
* Xilinx Spartan 6 (toolchains: ISE);
* Xilinx 7-series (toolchains: Vivado);
* Xilinx UltraScale (toolchains: Vivado);
* Lattice Nexus (toolchains: **Yosys+nextpnr**, Diamond);
* AMD Spartan 3A (toolchains: ISE);
* AMD Spartan 6 (toolchains: ISE);
* AMD 7-series (toolchains: Vivado);
* AMD UltraScale (toolchains: Vivado);
* Intel (toolchains: Quartus);
* Quicklogic EOS S3 (toolchains: **Yosys+VPR**).

Expand All @@ -47,4 +52,4 @@ Amaranth has a dedicated IRC channel, [#amaranth-lang at libera.chat](https://we

## License

Amaranth is released under the very permissive [two-clause BSD license](LICENSE.txt). Under the terms of this license, you are authorized to use Amaranth for closed-source proprietary designs.
Amaranth is released under the [two-clause BSD license](LICENSE.txt). You are permitted to use Amaranth for open-source and proprietary designs provided that the copyright notice in the license file is reproduced.
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ dynamic = ["version"]

name = "amaranth"
description = "Amaranth hardware definition language"
readme = "README.md"
authors = [{name = "Amaranth HDL contributors"}]
license = {file = "LICENSE.txt"}

Expand Down

0 comments on commit 4a12946

Please sign in to comment.