From 33f14122add70f4ba46c7b077560bc05b041d490 Mon Sep 17 00:00:00 2001 From: Michael Cardell Widerkrantz Date: Tue, 11 Mar 2025 15:18:14 +0100 Subject: [PATCH] doc: Add note about building --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 84306a9..1d182e7 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,27 @@ https://github.com/tillitis/tkey-libs but keep our own copy of it in the repo. See below. +## Building + +Building is probably easiest using make and Podman. Do this to see all +targets: + +``` +cd contrib +make +``` + +Build the entire FPGA bitstream, which includes the firmware, using +Podman: + +``` +cd contrib +make run-make +``` + +See the [Tillitis Developer Handbook](https://dev.tillitis.se) for +more. + ## Updating and working with tkey-libs A copy of [tkey-libs](https://github.com/tillitis/tkey-libs) is kept