Updated readme and docs to point at dev.tillitis.se.

This commit is contained in:
dehanj 2024-03-15 15:04:57 +01:00 committed by Michael Cardell Widerkrantz
parent 4d4db70590
commit 159b5b052b
No known key found for this signature in database
GPG Key ID: D3DB3DDF57E704E5
6 changed files with 44 additions and 21 deletions

View File

@ -43,41 +43,48 @@ security-critical operations.
*The TK1 PCB, the first implementation of the TKey.* *The TK1 PCB, the first implementation of the TKey.*
## Documentation ## Getting started
The official website is [tillitis.se](https://tillitis.se).
### Getting started The Tkey can be purchased at
[shop.tillitis.se](https://shop.tillitis.se).
* [tillitis-key1-apps repository](https://github.com/tillitis/tillitis-key1-apps), All documentation concerning the TKey has been migrated to [TKey
with device apps and client apps for using the TKey Developer Handbook](https://dev.tillitis.se).
* [Quickstart](doc/quickstart.md) to initial programming of the TKey
(only required for the DevKit)
* [Toolchain setup](doc/toolchain_setup.md)
* [Release Notes](doc/release_notes.md)
### In-depth technical information
* [System Description](doc/system_description/system_description.md) ## Tkey Device Apps
Offically supported apps can be found at
[tillitis.se](https://tillitis.se/download/)
The source and other projects from us can be found here at our
[GitHub](https://github.com/tillitis).
Other known (but not all) projects can be found at
[dev.tillitis.se](https://dev.tillitis.se/projects/).
### Other noteworthy links
* [Threat Model](doc/threat_model/threat_model.md) * [Threat Model](doc/threat_model/threat_model.md)
* [Framing Protocol](doc/framing_protocol/framing_protocol.md) * [Release Notes](doc/release_notes.md)
* [Boards](doc/system_description/boards.md) * [Quickstart for the DevKit](doc/quickstart.md). Initial programming
* [FPGA](doc/system_description/fpga.md) if you have the "old" DevKit.
* [Software](doc/system_description/software.md)
* [QEMU](https://github.com/tillitis/qemu/tree/tk1) (branch `tk1` in
separate repository)
Note that development is ongoing. For example, changes might be made
to the measuring and derivation of key material, causing the Note that development is ongoing. To avoid unexpected changes of
public/private keys of a signer app to change. To avoid unexpected derived key material, please use a tagged release. Read the [Release
changes, please use a tagged release. Read the [Release
Notes](doc/release_notes.md) to keep up to date with changes and new Notes](doc/release_notes.md) to keep up to date with changes and new
releases. releases.
## About this repository ## About this repository
This repository contains hardware, software and utilities written as This repository contains hardware, firmware and utilities written as
part of the TKey. It is structured as monolithic repository, or part of the TKey. It is structured as monolithic repository, or
"monorepo", where all components live in one repository. "monorepo", where all components live in one repository.
Device and client applications, however, are kept in other
repositories here at our [GitHub](https://github.com/tillitis).
## Licensing ## Licensing
See [LICENSES](./LICENSES/README.md) for more information about See [LICENSES](./LICENSES/README.md) for more information about

View File

@ -1,5 +1,8 @@
# Framing Protocol # Framing Protocol
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
history. This is likely to be outdated.
#### Version #### Version
* Version: Draft 1.3 * Version: Draft 1.3
* 2021-12-20 * 2021-12-20

View File

@ -1,5 +1,9 @@
# Tillitis TKey Quickstart # Tillitis TKey Quickstart
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
history. This is likely to be outdated, and are only relevant if you
have an "older" DevKit, typically handed out during OSFC 2022.
This document describes how to build the FPGA bitstream, including the This document describes how to build the FPGA bitstream, including the
firmware, and get this programmed onto the flash memory of the firmware, and get this programmed onto the flash memory of the
Tillitis TKey USB device. Tillitis TKey USB device.

View File

@ -1,5 +1,8 @@
# Tillitis TKey software # Tillitis TKey software
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
history. This is likely to be outdated.
## Introduction ## Introduction
This text is both an introduction to and a requirement specification This text is both an introduction to and a requirement specification

View File

@ -1,5 +1,8 @@
# System Description # System Description
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
history. This is likely to be outdated.
## Purpose and Revision ## Purpose and Revision
The purpose of this document is to provide a description of the The purpose of this document is to provide a description of the

View File

@ -1,5 +1,8 @@
# Toolchain setup # Toolchain setup
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
history. This is likely to be outdated.
Here are instructions for setting up the tools required to build the Here are instructions for setting up the tools required to build the
project. Tested on Ubuntu 22.10. project. Tested on Ubuntu 22.10.