Skip to content

update docs

update docs #127

Workflow file for this run

name: Zig
on:
pull_request:
workflow_dispatch:
push:
branches:
- main
paths:
- decoder/**
jobs:
format:
name: Format
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install zig
uses: mlugg/setup-zig@v1
with:
version: 0.13.0
- name: Format
run: zig fmt --check .
test:
name: Test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install python design tools
run: |
python -m pip install -e ./design/
- name: Generate secrets
run: |
python -m ectf25_design.gen_secrets -f secrets/secrets.json 1 2 3
- name: Install zig
uses: mlugg/setup-zig@v1
with:
version: 0.13.0
- name: Run tests
working-directory: decoder
run: zig build test --summary all
docs:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install python design tools
run: |
python -m pip install -e ./design/
- name: Generate secrets
run: |
python -m ectf25_design.gen_secrets -f secrets/secrets.json 1 2 3
- name: Install zig
uses: mlugg/setup-zig@v1
with:
version: 0.13.0
- name: Install msdk
run: |
git clone --depth=1 --branch v2024_02 https://github.com/Analog-Devices-MSDK/msdk
echo "MAXIM_PATH=$PWD/msdk" >> $GITHUB_ENV
- name: Install ed25519
run: |
git clone --depth=1 https://github.com/orlp/ed25519
echo "ED25519_PATH=$PWD/ed25519" >> $GITHUB_ENV
- name: Install ARM GCC
run: |
sudo apt-get install -y gcc-arm-none-eabi
- name: Build documentation
working-directory: decoder
run: zig build docs