mirror of
https://github.com/tillitis/tillitis-key1.git
synced 2024-10-01 01:45:38 -04:00
Updated readme and docs to point at dev.tillitis.se.
This commit is contained in:
parent
4d4db70590
commit
159b5b052b
49
README.md
49
README.md
@ -43,41 +43,48 @@ security-critical operations.
|
||||
*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),
|
||||
with device apps and client apps for using the TKey
|
||||
* [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)
|
||||
All documentation concerning the TKey has been migrated to [TKey
|
||||
Developer Handbook](https://dev.tillitis.se).
|
||||
|
||||
### 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)
|
||||
* [Framing Protocol](doc/framing_protocol/framing_protocol.md)
|
||||
* [Boards](doc/system_description/boards.md)
|
||||
* [FPGA](doc/system_description/fpga.md)
|
||||
* [Software](doc/system_description/software.md)
|
||||
* [QEMU](https://github.com/tillitis/qemu/tree/tk1) (branch `tk1` in
|
||||
separate repository)
|
||||
* [Release Notes](doc/release_notes.md)
|
||||
* [Quickstart for the DevKit](doc/quickstart.md). Initial programming
|
||||
if you have the "old" DevKit.
|
||||
|
||||
Note that development is ongoing. For example, changes might be made
|
||||
to the measuring and derivation of key material, causing the
|
||||
public/private keys of a signer app to change. To avoid unexpected
|
||||
changes, please use a tagged release. Read the [Release
|
||||
|
||||
Note that development is ongoing. To avoid unexpected changes of
|
||||
derived key material, please use a tagged release. Read the [Release
|
||||
Notes](doc/release_notes.md) to keep up to date with changes and new
|
||||
releases.
|
||||
|
||||
## 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
|
||||
"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
|
||||
|
||||
See [LICENSES](./LICENSES/README.md) for more information about
|
||||
|
@ -1,5 +1,8 @@
|
||||
# Framing Protocol
|
||||
|
||||
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
|
||||
history. This is likely to be outdated.
|
||||
|
||||
#### Version
|
||||
* Version: Draft 1.3
|
||||
* 2021-12-20
|
||||
|
@ -1,5 +1,9 @@
|
||||
# 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
|
||||
firmware, and get this programmed onto the flash memory of the
|
||||
Tillitis TKey USB device.
|
||||
|
@ -1,5 +1,8 @@
|
||||
# Tillitis TKey software
|
||||
|
||||
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
|
||||
history. This is likely to be outdated.
|
||||
|
||||
## Introduction
|
||||
|
||||
This text is both an introduction to and a requirement specification
|
||||
|
@ -1,5 +1,8 @@
|
||||
# System Description
|
||||
|
||||
**NOTE:** Documentation migrated to dev.tillitis.se, this is kept for
|
||||
history. This is likely to be outdated.
|
||||
|
||||
## Purpose and Revision
|
||||
|
||||
The purpose of this document is to provide a description of the
|
||||
|
@ -1,5 +1,8 @@
|
||||
# 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
|
||||
project. Tested on Ubuntu 22.10.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user