Skip to content

Commit

Permalink
Revise README
Browse files Browse the repository at this point in the history
- Removed extra whitespace.
- Fixed markup errors with `.
- Spelling.
- Link Github releases.
  • Loading branch information
mchack-work committed Sep 3, 2024
1 parent 3453c5f commit 15256bc
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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.


Expand Down Expand Up @@ -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.

0 comments on commit 15256bc

Please sign in to comment.