Skip to content

docs: add project README #7

docs: add project README

docs: add project README #7

Workflow file for this run

name: CI
on:
push:
branches: ["**"]
pull_request:
jobs:
quality:
name: Quality (macOS)
runs-on: macos-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Guard local artifacts
run: ./scripts/check_local_artifacts.sh
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- name: Install cargo-audit
uses: taiki-e/install-action@cargo-audit
- name: Format
run: cargo fmt --all -- --check
- name: Clippy
run: cargo clippy --all-targets --no-deps
- name: Test
run: cargo test
- name: Build
run: cargo build
- name: Audit
run: cargo audit
non_macos_compile:
name: Non-macOS Compile Check
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Guard local artifacts
run: ./scripts/check_local_artifacts.sh
- name: Install Linux native build deps
run: |
sudo apt-get update
sudo apt-get install -y pkg-config libwayland-dev libxkbcommon-dev libudev-dev libasound2-dev
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
- name: Native Linux check
run: cargo check