Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document container targets #47

Open
mchack-work opened this issue Jun 4, 2024 · 2 comments
Open

Document container targets #47

mchack-work opened this issue Jun 4, 2024 · 2 comments

Comments

@mchack-work
Copy link
Member

In the build bitstream section in the Dev Handbook we exhort people to use the tkey-builder image for building but don't mention the make targets under contrib, like run-make. We probably should mention them.

Perhaps we also could change the quickstart things in tillitis-key1 to mention this?

@dehanj
Copy link
Member

dehanj commented Jun 7, 2024

I did some improvements and corrections in #48

I added some contrib targets, but I would say that we needs to make another tillitis-key1 release in order to make this better - the simplest is to add a target something like this:

build-unlocked:
        podman run --rm --mount type=bind,source="`pwd`/../hw/application_fpga",target=/build -w /build -it \
         $(IMAGE) make clean secret application_fpga.bin

(the name of the target we can discuss).

Then I would propose that we add a requirement that one need to have make installed in path. Then only one make command is needed to build the entire firmware with the generated secret, and we no longer need the user to jump around inside a container to fire commands.

It would maybe be even better to add a script that either calls the make target above, and checks that podman, make etc exists in path too. Or simply calls the podman command to remove the need for make? But then we have another script to maintain.

Made a draft PR about it tillitis/tillitis-key1#232

@mchack-work
Copy link
Member Author

I agree that it would be very nice to add a script. I'll check out the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants