Skip to content

Commit 8677ced

Browse files
committed
Update README.
1 parent 0eac9c3 commit 8677ced

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,23 @@ See the [Introduction](https://amaranth-lang.org/docs/amaranth/latest/intro.html
2222

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

25-
## Supported devices
25+
## Usage
26+
27+
See the [Language guide](https://amaranth-lang.org/docs/amaranth/latest/guide.html) section of the documentation.
28+
29+
## Platform support
2630

2731
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:
2832

2933
* Lattice iCE40 (toolchains: **Yosys+nextpnr**, LSE-iCECube2, Synplify-iCECube2);
3034
* Lattice MachXO2 (toolchains: Diamond);
3135
* Lattice MachXO3L (toolchains: Diamond);
3236
* Lattice ECP5 (toolchains: **Yosys+nextpnr**, Diamond);
33-
* Xilinx Spartan 3A (toolchains: ISE);
34-
* Xilinx Spartan 6 (toolchains: ISE);
35-
* Xilinx 7-series (toolchains: Vivado);
36-
* Xilinx UltraScale (toolchains: Vivado);
37+
* Lattice Nexus (toolchains: **Yosys+nextpnr**, Diamond);
38+
* AMD Spartan 3A (toolchains: ISE);
39+
* AMD Spartan 6 (toolchains: ISE);
40+
* AMD 7-series (toolchains: Vivado);
41+
* AMD UltraScale (toolchains: Vivado);
3742
* Intel (toolchains: Quartus);
3843
* Quicklogic EOS S3 (toolchains: **Yosys+VPR**).
3944

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

4853
## License
4954

50-
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.
55+
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.

pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ dynamic = ["version"]
88

99
name = "amaranth"
1010
description = "Amaranth hardware definition language"
11+
readme = "README.md"
1112
authors = [{name = "Amaranth HDL contributors"}]
1213
license = {file = "LICENSE.txt"}
1314

0 commit comments

Comments
 (0)