From 15256bc23fb38d210203804ae0e54d692681d860 Mon Sep 17 00:00:00 2001 From: Michael Cardell Widerkrantz Date: Tue, 3 Sep 2024 13:10:47 +0200 Subject: [PATCH] Revise README - Removed extra whitespace. - Fixed markup errors with `. - Spelling. - Link Github releases. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a107b06..3c9fcc4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # TK1 PCBA This repository contains the PCB design and manufacturing files for -the flexible Open Source security key, TKey (TK1). +the flexible Open Source security key, TKey (TK1). This is part of a larger project that includes firmware and FPGA designs, which are housed at @@ -18,12 +18,13 @@ For more general information about the TKey see, - tk1, under hw - mta1-usb-v1, under prototypes - mta1-usb-dev, under prototypes -- Manufacturing outputs (Gerber files, BOM, etc.), under releases +- Manufacturing outputs (Gerber files, BOM, etc.), under [Github + releases](https://github.com/tillitis/tk1-pcba/releases) - Libraries, under hw/lib The earlier version of TK1, such as the `mta1-usb-v1` and `mta1-usb-dev`, that can be found under `prototypes/` are kept for -historical reasons. TK1 is the only version that is maintaned and +historical reasons. TK1 is the only version that is maintained and developed. ## Getting started @@ -43,7 +44,7 @@ The KiBot flow can be run locally using the Make target make run-kibot ``` -the prerequisits are `Podman`. `Docker can also be used`, see the +the prerequisits are `Podman`. `Docker` can also be used, see the Makefile for details. @@ -89,4 +90,4 @@ All filtered commits have intact date, author, and code. Some unrelated files are removed from some commits, but the commit messages are left unchanged. Commit sha, tags and signatures are new. For complete history, please see tillitis/tillitis-key1 from commit -354aecb` and earlier. +`354aecb` and earlier.