From 673a6308ebf776df29d0a3175cd64f503a496f52 Mon Sep 17 00:00:00 2001 From: Asherah Connor Date: Sun, 16 Jun 2024 17:21:24 +0300 Subject: [PATCH] README: elaborate. --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 74493c9..663b64a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # niar -A small framework for building projects with [Amaranth]. +A small framework for building projects with [Amaranth]. Provides support for using [CXXRTL], optionally with [Zig] and [zxxrtl]. -See the [template project] for usage. +See the [template project] for usage, and [ili9341spi] for a complete example with Zig. [Amaranth]: https://amaranth-lang.org/ +[CXXRTL]: https://yosyshq.readthedocs.io/projects/yosys/en/latest/cmd/write_cxxrtl.html +[Zig]: https://ziglang.org/ +[zxxrtl]: https://github.com/kivikakk/zxxrtl [template project]: https://github.com/kivikakk/niar/tree/main/template - +[ili9341spi]: https://github.com/kivikakk/ili9341spi