Skip to content

Commit

Permalink
Update readme, use tkey-builder:4, add IMAGE variable for Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
dehanj committed Mar 27, 2024
1 parent 92120ad commit 4380cf7
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
ci:
runs-on: ubuntu-latest
container:
image: ghcr.io/tillitis/tkey-builder:2
image: ghcr.io/tillitis/tkey-builder:4
steps:
- name: checkout
uses: actions/checkout@v4
Expand Down
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ LDFLAGS=-T app.lds -L libcommon/ -lcommon -L libcrt0/ -lcrt0
.PHONY: all
all: libcrt0.a libcommon.a libmonocypher.a

IMAGE=ghcr.io/tillitis/tkey-builder:4

podman:
podman run --rm --mount type=bind,source=$(CURDIR),target=/src \
-w /src -it ghcr.io/tillitis/tkey-builder:2 make -j
-w /src -it $(IMAGE) make -j

.PHONY: check
check:
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- C runtime: libcrt0.
- Common C functions including protocol calls: libcommon.
- Cryptographic functions: libmonocypher.
Based on monocypher version 4.0.1
Based on monocypher version 4.0.2
https://github.com/LoupVaillant/Monocypher

Relase notes in [RELEASE.md](RELEASE.md).
Expand Down Expand Up @@ -50,31 +50,31 @@ the SPDX License List at:
https://spdx.org/licenses/

## Building
In order to build, you must have the `make`, `clang`, `llvm`, and
`lld` packages installed.

To build you need at least `make`, `clang`, `llvm`, and `lld` packages installed.

Version 15 or later of LLVM/Clang is required for the RV32IC\_Zmmul
architecture we use. Ubuntu 22.10 (Kinetic) is known to work. Please
see
[toolchain_setup.md](https://github.com/tillitis/tillitis-key1/blob/main/doc/toolchain_setup.md)
(in the tillitis-key1 repository) for detailed information on the
currently supported build and development environment.

## Building using podman
Version 15 or higher of LLVM/Clang is necessary for the RV32IC\_Zmmul
architecture we are using. For more detailed information on the
supported build and development environment, please refer to the
[Developer Handbook](https://dev.tillitis.se/).
## Building using Podman

You can also build the libraries with our OCI image
`ghcr.io/tillitis/tkey-builder`.
`ghcr.io/tillitis/tkey-builder`.

The easiest way to build this is if you have `make` installed:

```
make podman
```

Or use podman directly:
You can also specify a different image by using
`IMAGE=localhost/tkey-builder-local`.

Or use Podman directly:

```
podman run --rm --mount type=bind,source=.,target=/src -w /src -it ghcr.io/tillitis/tkey-builder:1 make -j
podman run --rm --mount type=bind,source=.,target=/src -w /src -it ghcr.io/tillitis/tkey-builder:4 make -j
```

## Minimal application build
Expand Down

0 comments on commit 4380cf7

Please sign in to comment.