Skip to content

Commit

Permalink
Document building with pre-built tkey-libs
Browse files Browse the repository at this point in the history
  • Loading branch information
mchack-work committed Aug 21, 2024
1 parent c8c7776 commit e237896
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ LIBDIR ?= $(P)/../tkey-libs

CC = clang

INCLUDE=$(LIBDIR)/include
INCLUDE = $(LIBDIR)/include

# If you want libcommon's qemu_puts() et cetera to output something on our QEMU
# debug port, use -DQEMU_DEBUG below
Expand Down
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,23 @@ These scripts automatilly clone the [tkey-libs device
libraries](https://github.com/tillitis/tkey-libs) in a directory next
to this one.

### Installing Podman
If you want to use a pre-built libraries, download the libraries tar
ball from

https://github.com/tillitis/tkey-libs/releases

unpack it, and specify where you unpacked it in `LIBDIR` when
building:

```
make LIBDIR=~/Downloads/tkey-libs-v0.1.1
```

Note that your `lld` might complain if they were built with a
different version. If so, either use the same version the release used
or use podman.

### Building with Podman

On Ubuntu 22.10, running

Expand All @@ -143,6 +159,22 @@ apt install podman rootlesskit slirp4netns

should be enough to get you a working Podman setup.

You can then either:

- Use `build-podman.sh` as described above, which clones and builds
the tkey-libs libraries as well.

- Download [pre-built versions of the tkey-libs
libraries](https://github.com/tillitis/tkey-libs/releases) and
define `LIBDIR` to where you unpacked the tkey-libs, something
like:

```
make LIBDIR=$HOME/Downloads/tkey-libs-v0.1.1 podman
```

Note that `~` expansion doesn't work.

### Building with host tools

To build with native tools you need at least the `clang`, `llvm`,
Expand Down

0 comments on commit e237896

Please sign in to comment.